wz2cool / local-queue / #88

Committed 11 Feb 2025 01:57PM UTC coverage: 90.82% (-0.4%) from 91.187%

Build # #88

Build Type

push

Committed by

Commit Message

Merge pull request #16 from wz2cool/0.2.5-1

fix close slow issue

Run Details

10 of 12 new or added lines in 2 files covered. (83.33%)

3 existing lines in 1 file now uncovered.

742 of 817 relevant lines covered (90.82%)

0.91 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

86.15

/src/main/java/com/github/wz2cool/localqueue/impl/SimpleProducer.java

package com.github.wz2cool.localqueue.impl;

import com.github.wz2cool.localqueue.IProducer;
import com.github.wz2cool.localqueue.event.CloseListener;
import com.github.wz2cool.localqueue.helper.ChronicleQueueHelper;
import com.github.wz2cool.localqueue.model.config.SimpleProducerConfig;
import com.github.wz2cool.localqueue.model.message.InternalWriteMessage;
import net.openhft.chronicle.core.time.TimeProvider;
import net.openhft.chronicle.queue.ChronicleQueue;
import net.openhft.chronicle.queue.ExcerptAppender;
import net.openhft.chronicle.queue.RollCycle;
import net.openhft.chronicle.queue.impl.single.SingleChronicleQueue;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.time.LocalDate;
import java.time.format.DateTimeFormatter;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.*;
import java.util.concurrent.atomic.AtomicBoolean;

/**
 * simple writer
 *
 * @author frank
 */
@SuppressWarnings("Duplicates")
public class SimpleProducer implements IProducer {

    private final Logger logger = LoggerFactory.getLogger(this.getClass());
    private final RollCycle defaultRollCycle;
    private final TimeProvider timeProvider;
    private final SimpleProducerConfig config;
    private final SingleChronicleQueue queue;
    private final LinkedBlockingQueue<InternalWriteMessage> messageCache = new LinkedBlockingQueue<>();
    // should only call by flushExecutor
    private final ExcerptAppender mainAppender;
    private final ExecutorService flushExecutor = Executors.newSingleThreadExecutor();
    private final ScheduledExecutorService scheduler = Executors.newScheduledThreadPool(1);
    private final DateTimeFormatter dateFormatter = DateTimeFormatter.ofPattern("yyyyMMdd");
    private final ConcurrentLinkedQueue<CloseListener> closeListeners = new ConcurrentLinkedQueue<>();

    private final AtomicBoolean isFlushRunning = new AtomicBoolean(true);
    private final AtomicBoolean isClosing = new AtomicBoolean(false);
    private final AtomicBoolean isClosed = new AtomicBoolean(false);
    private final Object closeLocker = new Object();

    public SimpleProducer(final SimpleProducerConfig config) {
        this.config = config;
        this.timeProvider = ChronicleQueueHelper.getTimeProvider(config.getTimeZone());
        this.defaultRollCycle = ChronicleQueueHelper.getRollCycle(config.getRollCycleType());
        this.queue = ChronicleQueue.singleBuilder(config.getDataDir())
                .rollCycle(defaultRollCycle)
                .timeProvider(timeProvider)
                .build();
        this.mainAppender = initMainAppender();
        flushExecutor.execute(this::flush);
        scheduler.scheduleAtFixedRate(() -> cleanUpOldFiles(config.getKeepDays()), 0, 1, TimeUnit.HOURS);
    }

    private ExcerptAppender initMainAppender() {
        return CompletableFuture.supplyAsync(this.queue::createAppender, this.flushExecutor).join();
    }

    // region flush to file

    private void stopFlush() {
        isFlushRunning.set(false);
    }

    private void flush() {
        while (isFlushRunning.get() && !isClosing.get()) {
            flushMessages(config.getFlushBatchSize());
        }
    }

    private final List<InternalWriteMessage> tempFlushMessages = new ArrayList<>();

    private void flushMessages(int batchSize) {
        try {
            logDebug("[flushInternal] start");
            if (tempFlushMessages.isEmpty()) {
                // take 主要作用就是卡主线程
                InternalWriteMessage firstItem = this.messageCache.poll(config.getFlushInterval(), TimeUnit.MILLISECONDS);
                if (firstItem == null) {
                    return;
                }
                this.tempFlushMessages.add(firstItem);
                // 如果空了从消息缓存放入待刷消息
                this.messageCache.drainTo(tempFlushMessages, batchSize - 1);
            }
            doFlushMessages(tempFlushMessages);
            tempFlushMessages.clear();
        } catch (InterruptedException ex) {
            Thread.currentThread().interrupt();
        } catch (Exception ex) {
            logger.error("[flushInternal] flush error", ex);
        } finally {
            logDebug("[flushInternal] end");
        }
    }

    private void doFlushMessages(final List<InternalWriteMessage> messages) {
        synchronized (closeLocker) {
            try {
                logDebug("[flushMessages] start");
                if (isClosing.get()) {
                    logDebug("[flushMessages] producer is closing");
                    return;
                }

                for (InternalWriteMessage message : messages) {
                    long writeTime = System.currentTimeMillis();
                    message.setWriteTime(writeTime);
                    mainAppender.writeBytes(message);
                }
            } finally {
                logDebug("[flushMessages] end");
            }
        }
    }

    // endregion


    @Override
    public boolean offer(String message) {
        return offer(null, message);
    }

    @Override
    public boolean offer(String messageKey, String message) {
        InternalWriteMessage internalWriteMessage = new InternalWriteMessage();
        internalWriteMessage.setContent(message);
        internalWriteMessage.setMessageKey(messageKey);
        return this.messageCache.offer(internalWriteMessage);
    }

    @Override
    public boolean offer(String tag, String messageKey, String message) {
        InternalWriteMessage internalWriteMessage = new InternalWriteMessage();
        internalWriteMessage.setContent(message);
        internalWriteMessage.setMessageKey(messageKey);
        internalWriteMessage.setTag(tag);
        return this.messageCache.offer(internalWriteMessage);
    }

    /**
     * get the last position
     *
     * @return this last position
     */
    public long getLastPosition() {
        return this.queue.lastIndex();
    }

    // region close

    /**
     * is closed.
     *
     * @return true if the Producer is closed, false otherwise.
     */
    @Override
    public boolean isClosed() {
        return isClosed.get();
    }

    @Override
    public void close() {
        logDebug("[close] start");
        if (isClosing.get()) {
            logDebug("[close] is closing");
            return;
        }
        isClosing.set(true);
        stopFlush();
        synchronized (closeLocker) {
            try {
                if (!queue.isClosed()) {
                    queue.close();
                }
                flushExecutor.shutdown();
                scheduler.shutdown();
                try {
                    if (!scheduler.awaitTermination(1, TimeUnit.SECONDS)) {
                        scheduler.shutdownNow();
                    }
                    if (!flushExecutor.awaitTermination(1, TimeUnit.SECONDS)) {
                        flushExecutor.shutdownNow();
                    }
                } catch (InterruptedException e) {
                    scheduler.shutdownNow();
                    flushExecutor.shutdownNow();
                    Thread.currentThread().interrupt();
                }
                for (CloseListener closeListener : closeListeners) {
                    closeListener.onClose();
                }
                isClosed.set(true);
            } finally {
                logDebug("[close] end");
            }
        }
    }

    @Override
    public void addCloseListener(CloseListener listener) {
        closeListeners.add(listener);
    }

    private void cleanUpOldFiles(int keepDays) {
        if (keepDays == -1) {
            // no need clean up old files
            return;
        }
        logDebug("[cleanUpOldFiles] start");
        try {
            // Assuming .cq4 is the file extension for Chronicle Queue
            File[] files = config.getDataDir().listFiles((dir, name) -> name.endsWith(".cq4"));
            if (files == null || files.length == 0) {
                logDebug("[cleanUpOldFiles] no files found");
                return;
            }
            LocalDate now = LocalDate.now();
            LocalDate keepStartDate = now.minusDays(keepDays);
            for (File file : files) {
                cleanUpOldFile(file, keepStartDate);
            }
        } catch (Exception ex) {
            logger.error("[cleanUpOldFiles] error", ex);
        } finally {
            logDebug("[cleanUpOldFiles] end");
        }
    }


    private void cleanUpOldFile(final File file, final LocalDate keepDate) throws IOException {
        String fileName = file.getName();
        String dateString = fileName.substring(0, 8);
        LocalDate localDate = LocalDate.parse(dateString, this.dateFormatter);
        if (localDate.isBefore(keepDate)) {
            Files.deleteIfExists(file.toPath());
            logDebug("[cleanUpOldFile] Deleted old file: {}", file.getName());
        }
    }

    // endregion

    // region logger
    private void logDebug(String format, String arg) {
        if (logger.isDebugEnabled()) {
            logger.debug(format, arg);
        }
    }


    private void logDebug(String format) {
        if (logger.isDebugEnabled()) {
            logger.debug(format);
        }
    }

    // endregion
}

1	package com.github.wz2cool.localqueue.impl;
2
3	import com.github.wz2cool.localqueue.IProducer;
4	import com.github.wz2cool.localqueue.event.CloseListener;
5	import com.github.wz2cool.localqueue.helper.ChronicleQueueHelper;
6	import com.github.wz2cool.localqueue.model.config.SimpleProducerConfig;
7	import com.github.wz2cool.localqueue.model.message.InternalWriteMessage;
8	import net.openhft.chronicle.core.time.TimeProvider;
9	import net.openhft.chronicle.queue.ChronicleQueue;
10	import net.openhft.chronicle.queue.ExcerptAppender;
11	import net.openhft.chronicle.queue.RollCycle;
12	import net.openhft.chronicle.queue.impl.single.SingleChronicleQueue;
13	import org.slf4j.Logger;
14	import org.slf4j.LoggerFactory;
15
16	import java.io.File;
17	import java.io.IOException;
18	import java.nio.file.Files;
19	import java.time.LocalDate;
20	import java.time.format.DateTimeFormatter;
21	import java.util.ArrayList;
22	import java.util.List;
23	import java.util.concurrent.*;
24	import java.util.concurrent.atomic.AtomicBoolean;
25
26	/**
27	* simple writer
28	*
29	* @author frank
30	*/
31	@SuppressWarnings("Duplicates")
32	public class SimpleProducer implements IProducer {
33
34	private final Logger logger = LoggerFactory.getLogger(this.getClass());	1✔
35	private final RollCycle defaultRollCycle;
36	private final TimeProvider timeProvider;
37	private final SimpleProducerConfig config;
38	private final SingleChronicleQueue queue;
39	private final LinkedBlockingQueue<InternalWriteMessage> messageCache = new LinkedBlockingQueue<>();	1✔
40	// should only call by flushExecutor
41	private final ExcerptAppender mainAppender;
42	private final ExecutorService flushExecutor = Executors.newSingleThreadExecutor();	1✔
43	private final ScheduledExecutorService scheduler = Executors.newScheduledThreadPool(1);	1✔
44	private final DateTimeFormatter dateFormatter = DateTimeFormatter.ofPattern("yyyyMMdd");	1✔
45	private final ConcurrentLinkedQueue<CloseListener> closeListeners = new ConcurrentLinkedQueue<>();	1✔
46
47	private final AtomicBoolean isFlushRunning = new AtomicBoolean(true);	1✔
48	private final AtomicBoolean isClosing = new AtomicBoolean(false);	1✔
49	private final AtomicBoolean isClosed = new AtomicBoolean(false);	1✔
50	private final Object closeLocker = new Object();	1✔
51
52	public SimpleProducer(final SimpleProducerConfig config) {	1✔
53	this.config = config;	1✔
54	this.timeProvider = ChronicleQueueHelper.getTimeProvider(config.getTimeZone());	1✔
55	this.defaultRollCycle = ChronicleQueueHelper.getRollCycle(config.getRollCycleType());	1✔
56	this.queue = ChronicleQueue.singleBuilder(config.getDataDir())	1✔
57	.rollCycle(defaultRollCycle)	1✔
58	.timeProvider(timeProvider)	1✔
59	.build();	1✔
60	this.mainAppender = initMainAppender();	1✔
61	flushExecutor.execute(this::flush);	1✔
62	scheduler.scheduleAtFixedRate(() -> cleanUpOldFiles(config.getKeepDays()), 0, 1, TimeUnit.HOURS);	1✔
63	}	1✔
64
65	private ExcerptAppender initMainAppender() {
66	return CompletableFuture.supplyAsync(this.queue::createAppender, this.flushExecutor).join();	1✔
67	}
68
69	// region flush to file
70
71	private void stopFlush() {
72	isFlushRunning.set(false);	1✔
73	}	1✔
74
75	private void flush() {
76	while (isFlushRunning.get() && !isClosing.get()) {	1✔
77	flushMessages(config.getFlushBatchSize());	1✔
78	}
79	}	1✔
80
81	private final List<InternalWriteMessage> tempFlushMessages = new ArrayList<>();	1✔
82
83	private void flushMessages(int batchSize) {
84	try {
85	logDebug("[flushInternal] start");	1✔
86	if (tempFlushMessages.isEmpty()) {	1✔
87	// take 主要作用就是卡主线程
88	InternalWriteMessage firstItem = this.messageCache.poll(config.getFlushInterval(), TimeUnit.MILLISECONDS);	1✔
89	if (firstItem == null) {	1✔
90	return;	1✔
91	}
92	this.tempFlushMessages.add(firstItem);	1✔
93	// 如果空了从消息缓存放入待刷消息
94	this.messageCache.drainTo(tempFlushMessages, batchSize - 1);	1✔
95	}
96	doFlushMessages(tempFlushMessages);	1✔
97	tempFlushMessages.clear();	1✔
98	} catch (InterruptedException ex) {	×
99	Thread.currentThread().interrupt();	×
100	} catch (Exception ex) {	×
101	logger.error("[flushInternal] flush error", ex);	×
102	} finally {
103	logDebug("[flushInternal] end");	1✔
104	}	1✔
105	}	1✔
106
107	private void doFlushMessages(final List<InternalWriteMessage> messages) {
108	synchronized (closeLocker) {	1✔
109	try {
110	logDebug("[flushMessages] start");	1✔
111	if (isClosing.get()) {	1✔
112	logDebug("[flushMessages] producer is closing");	×
113	return;	×
114	}
115
116	for (InternalWriteMessage message : messages) {	1✔
117	long writeTime = System.currentTimeMillis();	1✔
118	message.setWriteTime(writeTime);	1✔
119	mainAppender.writeBytes(message);	1✔
120	}	1✔
121	} finally {
122	logDebug("[flushMessages] end");	1✔
123	}	1✔
124	}	1✔
125	}	1✔
126
127	// endregion
128
129
130	@Override
131	public boolean offer(String message) {
132	return offer(null, message);	1✔
133	}
134
135	@Override
136	public boolean offer(String messageKey, String message) {
137	InternalWriteMessage internalWriteMessage = new InternalWriteMessage();	1✔
138	internalWriteMessage.setContent(message);	1✔
139	internalWriteMessage.setMessageKey(messageKey);	1✔
140	return this.messageCache.offer(internalWriteMessage);	1✔
141	}
142
143	@Override
144	public boolean offer(String tag, String messageKey, String message) {
145	InternalWriteMessage internalWriteMessage = new InternalWriteMessage();	1✔
146	internalWriteMessage.setContent(message);	1✔
147	internalWriteMessage.setMessageKey(messageKey);	1✔
148	internalWriteMessage.setTag(tag);	1✔
149	return this.messageCache.offer(internalWriteMessage);	1✔
150	}
151
152	/**
153	* get the last position
154	*
155	* @return this last position
156	*/
157	public long getLastPosition() {
158	return this.queue.lastIndex();	1✔
159	}
160
161	// region close
162
163	/**
164	* is closed.
165	*
166	* @return true if the Producer is closed, false otherwise.
167	*/
168	@Override
169	public boolean isClosed() {
170	return isClosed.get();	1✔
171	}
172
173	@Override
174	public void close() {
175	logDebug("[close] start");	1✔
176	if (isClosing.get()) {	1✔
NEW 177	logDebug("[close] is closing");	×
NEW 178	return;	×
179	}
180	isClosing.set(true);	1✔
181	stopFlush();	1✔
182	synchronized (closeLocker) {	1✔
183	try {
184	if (!queue.isClosed()) {	1✔
185	queue.close();	1✔
186	}
187	flushExecutor.shutdown();	1✔
188	scheduler.shutdown();	1✔
189	try {
190	if (!scheduler.awaitTermination(1, TimeUnit.SECONDS)) {	1✔
191	scheduler.shutdownNow();	×
192	}
193	if (!flushExecutor.awaitTermination(1, TimeUnit.SECONDS)) {	1✔
194	flushExecutor.shutdownNow();	×
195	}
196	} catch (InterruptedException e) {	×
197	scheduler.shutdownNow();	×
198	flushExecutor.shutdownNow();	×
199	Thread.currentThread().interrupt();	×
200	}	1✔
201	for (CloseListener closeListener : closeListeners) {	1✔
202	closeListener.onClose();	1✔
203	}	1✔
204	isClosed.set(true);	1✔
205	} finally {
206	logDebug("[close] end");	1✔
207	}	1✔
208	}	1✔
209	}	1✔
210
211	@Override
212	public void addCloseListener(CloseListener listener) {
213	closeListeners.add(listener);	1✔
214	}	1✔
215
216	private void cleanUpOldFiles(int keepDays) {
217	if (keepDays == -1) {	1✔
218	// no need clean up old files
219	return;	1✔
220	}
221	logDebug("[cleanUpOldFiles] start");	1✔
222	try {
223	// Assuming .cq4 is the file extension for Chronicle Queue
224	File[] files = config.getDataDir().listFiles((dir, name) -> name.endsWith(".cq4"));	1✔
225	if (files == null \|\| files.length == 0) {	1✔
226	logDebug("[cleanUpOldFiles] no files found");	1✔
227	return;	1✔
228	}
229	LocalDate now = LocalDate.now();	1✔
230	LocalDate keepStartDate = now.minusDays(keepDays);	1✔
231	for (File file : files) {	1✔
232	cleanUpOldFile(file, keepStartDate);	1✔
233	}
234	} catch (Exception ex) {	×
235	logger.error("[cleanUpOldFiles] error", ex);	×
236	} finally {
237	logDebug("[cleanUpOldFiles] end");	1✔
238	}	1✔
239	}	1✔
240
241
242	private void cleanUpOldFile(final File file, final LocalDate keepDate) throws IOException {
243	String fileName = file.getName();	1✔
244	String dateString = fileName.substring(0, 8);	1✔
245	LocalDate localDate = LocalDate.parse(dateString, this.dateFormatter);	1✔
246	if (localDate.isBefore(keepDate)) {	1✔
247	Files.deleteIfExists(file.toPath());	1✔
248	logDebug("[cleanUpOldFile] Deleted old file: {}", file.getName());	1✔
249	}
250	}	1✔
251
252	// endregion
253
254	// region logger
255	private void logDebug(String format, String arg) {
256	if (logger.isDebugEnabled()) {	1✔
257	logger.debug(format, arg);	×
258	}
259	}	1✔
260
261
262	private void logDebug(String format) {
263	if (logger.isDebugEnabled()) {	1✔
264	logger.debug(format);	×
265	}
266	}	1✔
267
268	// endregion
269	}

wz2cool / local-queue / #88

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous