การตั้งชื่อเธรดและเธรดพูลของ ExecutorService

สมมติว่าฉันมีแอปพลิเคชั่นที่ใช้ Executorเฟรมเวิร์ก

Executors.newSingleThreadExecutor().submit(new Runnable(){
    @Override
    public void run(){
        // do stuff
    }
}

เมื่อฉันเรียกใช้แอปพลิเคชันนี้ในดีบักเกอร์เธรดจะถูกสร้างขึ้นด้วยชื่อ (ค่าเริ่มต้น) ต่อไปนี้: Thread[pool-1-thread-1]ไปนี้: อย่างที่คุณเห็นนี่มันไม่มีประโยชน์มากนักและเท่าที่ฉันบอกได้Executorเฟรมเวิร์กไม่มีวิธีง่าย ๆ ในการตั้งชื่อเธรดหรือเธรดพูลที่สร้างขึ้น

ดังนั้นหนึ่งจะไปเกี่ยวกับการให้ชื่อสำหรับเธรด / thread-pool อย่างไร Thread[FooPool-FooThread]ยกตัวอย่างเช่น

คุณสามารถจัดหาไปThreadFactory newSingleThreadScheduledExecutor(ThreadFactory threadFactory)โรงงานจะรับผิดชอบในการสร้างเธรดและสามารถตั้งชื่อได้

วิธีอ้างJavadoc :

การสร้างกระทู้ใหม่

ThreadFactoryหัวข้อใหม่จะถูกสร้างขึ้นโดยใช้ หากไม่ได้ระบุไว้Executors.defaultThreadFactory()จะใช้a ซึ่งสร้างเธรดให้เหมือนกันทั้งหมดThreadGroupและมีNORM_PRIORITYลำดับความสำคัญและสถานะที่ไม่ใช่ภูตเดียวกัน โดยการจัดหาที่แตกต่างกันThreadFactoryคุณสามารถที่จะเปลี่ยนชื่อกระทู้ของกลุ่มด้ายความสำคัญสถานะภูต ฯลฯ ถ้าThreadFactoryล้มเหลวในการสร้างหัวข้อเมื่อถามโดยกลับ null จากnewThread, ผู้บริหารจะยังคง แต่อาจจะไม่สามารถที่จะดำเนินงานใด ๆ

ฝรั่งมักจะมีสิ่งที่คุณต้องการ

ThreadFactory namedThreadFactory = 
  new ThreadFactoryBuilder().setNameFormat("my-sad-thread-%d").build()

ExecutorServiceและผ่านมันออกไปของคุณ

คุณสามารถลองสร้างโรงงานด้ายของคุณเองซึ่งจะสร้างเธรดด้วยชื่อที่เหมาะสม นี่คือตัวอย่างหนึ่ง:

class YourThreadFactory implements ThreadFactory {
   public Thread newThread(Runnable r) {
     return new Thread(r, "Your name");
   }
 }

Executors.newSingleThreadExecutor(new YourThreadFactory()).submit(someRunnable);

คุณยังสามารถเปลี่ยนชื่อเธรดของคุณได้ในภายหลังในขณะที่ดำเนินการกับเธรด:

Thread.currentThread().setName("FooName");

อาจเป็นเรื่องที่น่าสนใจหากเช่นคุณกำลังใช้ ThreadFactory เดียวกันสำหรับงานประเภทต่างๆ

BasicThreadFactoryจาก Apache Commons-lang ยังเป็นประโยชน์เพื่อให้พฤติกรรมการตั้งชื่อ แทนที่จะเขียนคลาสภายในที่ไม่ระบุชื่อคุณสามารถใช้ตัวสร้างเพื่อตั้งชื่อเธรดตามที่คุณต้องการ นี่คือตัวอย่างจาก javadocs:

 // Create a factory that produces daemon threads with a naming pattern and
 // a priority
 BasicThreadFactory factory = new BasicThreadFactory.Builder()
     .namingPattern("workerthread-%d")
     .daemon(true)
     .priority(Thread.MAX_PRIORITY)
     .build();
 // Create an executor service for single-threaded execution
 ExecutorService exec = Executors.newSingleThreadExecutor(factory);

หากคุณกำลังใช้งาน Spring CustomizableThreadFactoryคุณสามารถตั้งค่าคำนำหน้าชื่อเธรดได้

ตัวอย่าง:

ExecutorService alphaExecutor =
    Executors.newFixedThreadPool(10, new CustomizableThreadFactory("alpha-"));

หรือคุณสามารถสร้างของคุณExecutorServiceเป็น Spring bean โดยใช้ThreadPoolExecutorFactoryBean- จากนั้นเธรดทั้งหมดจะถูกตั้งชื่อด้วยbeanName-คำนำหน้า

@Bean
public ThreadPoolExecutorFactoryBean myExecutor() {
    ThreadPoolExecutorFactoryBean executorFactoryBean = new ThreadPoolExecutorFactoryBean();
    // configuration of your choice
    return executorFactoryBean;
}

ในตัวอย่างด้านบนเธรดจะถูกตั้งชื่อด้วยmyExecutor-คำนำหน้า คุณสามารถตั้งค่าส่วนนำหน้าอย่างชัดเจนเป็นค่าอื่น (เช่น. "myPool-") โดยการตั้งค่าexecutorFactoryBean.setThreadNamePrefix("myPool-")จากโรงงานถั่ว

มีRFE แบบเปิดสำหรับสิ่งนี้กับ Oracle จากความคิดเห็นจากพนักงาน Oracle ดูเหมือนว่าพวกเขาไม่เข้าใจปัญหาและจะไม่แก้ไข เป็นหนึ่งในสิ่งเหล่านี้ที่ตายง่าย ๆ ในการสนับสนุนใน JDK (โดยไม่ทำลายความเข้ากันได้ไปข้างหลัง) ดังนั้นจึงเป็นเรื่องน่าละอายที่ RFE เข้าใจผิด

เป็นแหลมออกคุณจำเป็นต้องใช้ของคุณเองThreadFactory หากคุณไม่ต้องการที่จะดึงใน Guava หรือ Apache Commons เพียงเพื่อวัตถุประสงค์นี้ฉันให้การThreadFactoryใช้งานที่คุณสามารถใช้ที่นี่ มันคล้ายกับสิ่งที่คุณได้รับจาก JDK ยกเว้นความสามารถในการตั้งค่าส่วนนำหน้าชื่อเธรดเป็นอย่างอื่นที่ไม่ใช่ "พูล"

package org.demo.concurrency;

import java.util.concurrent.ThreadFactory;
import java.util.concurrent.atomic.AtomicInteger;

/**
 * ThreadFactory with the ability to set the thread name prefix. 
 * This class is exactly similar to 
 * {@link java.util.concurrent.Executors#defaultThreadFactory()}
 * from JDK8, except for the thread naming feature.
 *
 * <p>
 * The factory creates threads that have names on the form
 * <i>prefix-N-thread-M</i>, where <i>prefix</i>
 * is a string provided in the constructor, <i>N</i> is the sequence number of
 * this factory, and <i>M</i> is the sequence number of the thread created 
 * by this factory.
 */
public class ThreadFactoryWithNamePrefix implements ThreadFactory {

    // Note:  The source code for this class was based entirely on 
    // Executors.DefaultThreadFactory class from the JDK8 source.
    // The only change made is the ability to configure the thread
    // name prefix.


    private static final AtomicInteger poolNumber = new AtomicInteger(1);
    private final ThreadGroup group;
    private final AtomicInteger threadNumber = new AtomicInteger(1);
    private final String namePrefix;

    /**
     * Creates a new ThreadFactory where threads are created with a name prefix
     * of <code>prefix</code>.
     *
     * @param prefix Thread name prefix. Never use a value of "pool" as in that
     *      case you might as well have used
     *      {@link java.util.concurrent.Executors#defaultThreadFactory()}.
     */
    public ThreadFactoryWithNamePrefix(String prefix) {
        SecurityManager s = System.getSecurityManager();
        group = (s != null) ? s.getThreadGroup()
                : Thread.currentThread().getThreadGroup();
        namePrefix = prefix + "-"
                + poolNumber.getAndIncrement()
                + "-thread-";
    }


    @Override
    public Thread newThread(Runnable r) {
        Thread t = new Thread(group, r,
                namePrefix + threadNumber.getAndIncrement(),
                0);
        if (t.isDaemon()) {
            t.setDaemon(false);
        }
        if (t.getPriority() != Thread.NORM_PRIORITY) {
            t.setPriority(Thread.NORM_PRIORITY);
        }
        return t;
    }
}

เมื่อคุณต้องการที่จะใช้มันคุณก็สามารถใช้ประโยชน์จากความจริงที่ว่าทุกวิธีการช่วยให้คุณเพื่อให้คุณเองExecutorsThreadFactory

นี้

    Executors.newSingleThreadExecutor();

จะให้ ExecutorService โดยที่ชื่อเธรดมีpool-N-thread-Mแต่ใช้

    Executors.newSingleThreadExecutor(new ThreadFactoryWithNamePrefix("primecalc"));

คุณจะได้รับ ExecutorService primecalc-N-thread-Mที่หัวข้อที่มีการตั้งชื่อ Voila!

private class TaskThreadFactory implements ThreadFactory
{

    @Override
    public Thread newThread(Runnable r) {
        Thread t = new Thread(r, "TASK_EXECUTION_THREAD");

        return t;
    }

}

ส่งต่อ ThreadFactory ไปยังผู้ให้บริการและคุณก็พร้อมที่จะไป

วิธีที่รวดเร็วและสกปรกคือการใช้Thread.currentThread().setName(myName);ในrun()วิธีการ

ขยาย ThreadFactory

public interface ThreadFactory

วัตถุที่สร้างเธรดตามต้องการใหม่ การใช้โรงงานที่เป็นเธรดจะลบการเดินสายการเรียกไปยังเธรดใหม่ทำให้แอปพลิเคชันสามารถใช้คลาสย่อยของเธรดพิเศษลำดับความสำคัญ ฯลฯ

Thread newThread(Runnable r)

สร้างเธรดใหม่ การใช้งานอาจเริ่มต้นลำดับความสำคัญชื่อสถานะภูต ThreadGroup ฯลฯ

รหัสตัวอย่าง:

import java.util.concurrent.*;
import java.util.concurrent.atomic.*;

import java.util.concurrent.ThreadPoolExecutor.DiscardPolicy;

class SimpleThreadFactory implements ThreadFactory {
   String name;
   AtomicInteger threadNo = new AtomicInteger(0);

   public SimpleThreadFactory (String name){
       this.name = name;
   }
   public Thread newThread(Runnable r) {
     String threadName = name+":"+threadNo.incrementAndGet();
     System.out.println("threadName:"+threadName);
     return new Thread(r,threadName );
   }
   public static void main(String args[]){
        SimpleThreadFactory factory = new SimpleThreadFactory("Factory Thread");
        ThreadPoolExecutor executor= new ThreadPoolExecutor(1,1,60,
                    TimeUnit.SECONDS,new ArrayBlockingQueue<Runnable>(1),new ThreadPoolExecutor.DiscardPolicy());


        final ExecutorService executorService = Executors.newFixedThreadPool(5,factory);

        for ( int i=0; i < 100; i++){
            executorService.submit(new Runnable(){
                 public void run(){
                    System.out.println("Thread Name in Runnable:"+Thread.currentThread().getName());
                 }
            });
        }
        executorService.shutdown();
    }
 }

เอาท์พุท:

java SimpleThreadFactory

thread no:1
thread no:2
Thread Name in Runnable:Factory Thread:1
Thread Name in Runnable:Factory Thread:2
thread no:3
thread no:4
Thread Name in Runnable:Factory Thread:3
Thread Name in Runnable:Factory Thread:4
thread no:5
Thread Name in Runnable:Factory Thread:5

.... ฯลฯ

ตามคำตอบอื่น ๆ ที่ได้กล่าวไปแล้วคุณสามารถสร้างและใช้งานjava.util.concurrent.ThreadFactoryอินเทอร์เฟซของคุณเองได้(ไม่ต้องใช้ไลบรารีภายนอก) ฉันกำลังวางรหัสของฉันด้านล่างเพราะมันแตกต่างจากคำตอบก่อนหน้าเพราะมันใช้String.formatวิธีการและใช้ชื่อฐานสำหรับกระทู้เป็นอาร์กิวเมนต์ตัวสร้าง:

import java.util.concurrent.ThreadFactory;

public class NameableThreadFactory implements ThreadFactory{
    private int threadsNum;
    private final String namePattern;

    public NameableThreadFactory(String baseName){
        namePattern = baseName + "-%d";
    }

    @Override
    public Thread newThread(Runnable runnable){
        threadsNum++;
        return new Thread(runnable, String.format(namePattern, threadsNum));
    }    
}

และนี่คือตัวอย่างของการใช้งาน:

ThreadFactory  threadFactory = new NameableThreadFactory("listenerThread");        
final ExecutorService executorService = Executors.newFixedThreadPool(5, threadFactory);

แก้ไข : ทำให้ThreadFactoryการใช้งานเธรดของฉันปลอดภัยขอบคุณ@mchernyakov ที่ชี้ให้เห็น
แม้ว่าจะไม่มีที่ใดในThreadFactoryเอกสารที่กล่าวว่าการติดตั้งใช้งานต้องปลอดภัยต่อเธรด แต่ความจริงที่ว่าDefaultThreadFactoryปลอดภัยของเธรดนั้นมีนัยสำคัญ:

import java.util.concurrent.ThreadFactory;
import java.util.concurrent.atomic.AtomicInteger;

public class NameableThreadFactory implements ThreadFactory{
    private final AtomicInteger threadsNum = new AtomicInteger();

    private final String namePattern;

    public NameableThreadFactory(String baseName){
        namePattern = baseName + "-%d";
    }

    @Override
    public Thread newThread(Runnable runnable){
        return new Thread(runnable, String.format(namePattern, threadsNum.addAndGet(1)));
    }    
}

โซลูชัน Java core ที่ปลูกเองที่ฉันใช้เพื่อตกแต่งโรงงานที่มีอยู่:

public class ThreadFactoryNameDecorator implements ThreadFactory {
    private final ThreadFactory defaultThreadFactory;
    private final String suffix;

    public ThreadFactoryNameDecorator(String suffix) {
        this(Executors.defaultThreadFactory(), suffix);
    }

    public ThreadFactoryNameDecorator(ThreadFactory threadFactory, String suffix) {
        this.defaultThreadFactory = threadFactory;
        this.suffix = suffix;
    }

    @Override
    public Thread newThread(Runnable task) {
        Thread thread = defaultThreadFactory.newThread(task);
        thread.setName(thread.getName() + "-" + suffix);
        return thread;
    }
}

ในการดำเนินการ:

Executors.newSingleThreadExecutor(new ThreadFactoryNameDecorator("foo"));

Executors.newSingleThreadExecutor(r -> new Thread(r, "someName")).submit(getJob());

Runnable getJob() {
        return () -> {
            // your job
        };
}

คุณสามารถเขียนการใช้งาน ThreadFactory ของคุณเองโดยใช้ตัวอย่างการใช้งานที่มีอยู่แล้วบางส่วน (เช่น defaultThreadFactory) และเปลี่ยนชื่อในตอนท้าย

ตัวอย่างการใช้งาน ThreadFactory:

class ThreadFactoryWithCustomName implements ThreadFactory {
    private final ThreadFactory threadFactory;
    private final String name;

    public ThreadFactoryWithCustomName(final ThreadFactory threadFactory, final String name) {
        this.threadFactory = threadFactory;
        this.name = name;
    }

    @Override
    public Thread newThread(final Runnable r) {
        final Thread thread = threadFactory.newThread(r);
        thread.setName(name);
        return thread;
    }
}

และการใช้งาน:

Executors.newSingleThreadExecutor(new ThreadFactoryWithCustomName(
        Executors.defaultThreadFactory(),
        "customName")
    );

ฉันใช้เพื่อทำเช่นเดียวกันด้านล่าง (ต้องใช้guavaห้องสมุด):

ThreadFactory namedThreadFactory = new ThreadFactoryBuilder().setNameFormat("SO-POOL-%d").build();
ExecutorService executorService = Executors.newFixedThreadPool(5,namedThreadFactory);

ฉันพบว่ามันง่ายที่สุดในการใช้แลมบ์ดาเป็นโรงงานด้ายถ้าคุณต้องการเปลี่ยนชื่อผู้ปฏิบัติการเธรดเดี่ยว

Executors.newSingleThreadExecutor(runnable -> new Thread(runnable, "Your name"));

นี่คือโรงงานที่กำหนดเองของฉันซึ่งให้ชื่อที่กำหนดเองสำหรับเครื่องวิเคราะห์เธรดดัมพ์ ฉันมักจะให้tf=nullเพื่อนำมาใช้ใหม่โรงงานด้าย JVM เว็บไซต์นี้มีโรงงานด้ายขั้นสูงมากขึ้น

public class SimpleThreadFactory implements ThreadFactory {
    private ThreadFactory tf;
    private String nameSuffix;

    public SimpleThreadFactory (ThreadFactory tf, String nameSuffix) {
        this.tf = tf!=null ? tf : Executors.defaultThreadFactory();
        this.nameSuffix = nameSuffix; 
    }

    @Override public Thread newThread(Runnable task) {
        // default "pool-1-thread-1" to "pool-1-thread-1-myapp-MagicTask"
        Thread thread=tf.newThread(task);
        thread.setName(thread.getName()+"-"+nameSuffix);
        return thread;
    }
}

- - - - - 

ExecutorService es = Executors.newFixedThreadPool(4, new SimpleThreadFactory(null, "myapp-MagicTask") );

เพื่อความสะดวกของคุณนี่คือการวนรอบการถ่ายโอนข้อมูลเธรดสำหรับการตรวจแก้จุดบกพร่อง

    ThreadMXBean mxBean=ManagementFactory.getThreadMXBean();
    long[] tids = mxBean.getAllThreadIds();
    System.out.println("------------");
    System.out.println("ThreadCount="+tids.length);
    for(long tid : tids) {
        ThreadInfo mxInfo=mxBean.getThreadInfo(tid);
        if (mxInfo==null) {
            System.out.printf("%d %s\n", tid, "Thread not found");
        } else {
            System.out.printf("%d %s, state=%s, suspended=%d, lockowner=%d %s\n"
                    , mxInfo.getThreadId(), mxInfo.getThreadName()
                    , mxInfo.getThreadState().toString()
                    , mxInfo.isSuspended()?1:0
                    , mxInfo.getLockOwnerId(), mxInfo.getLockOwnerName()
            );
        }
    }