wz2cool / local-queue / #38

Committed 01 Feb 2025 12:36PM UTC coverage: 91.85% (-0.02%) from 91.871%

Build # #38

Build Type

push

Committed by

Commit Message

Merge pull request #6 from wz2cool/0.1.2

0.1.2

Coverage Stats

113 of 127 new or added lines in 9 files covered. (88.98%)

586 of 638 relevant lines covered (91.85%)

0.92 hits per line

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

87.8

/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.UUID;
import java.util.concurrent.*;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantLock;

/**
 * simple writer
 *
 * @author frank
 */
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 Lock internalLock = new ReentrantLock();
    private final ConcurrentLinkedQueue<CloseListener> closeListeners = new ConcurrentLinkedQueue<>();

    private volatile boolean isFlushRunning = true;
    private volatile boolean isClosing = false;
    private volatile boolean isClosed = false;

    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 flush() {
        while (isFlushRunning && !isClosing) {
            flushMessages(config.getFlushBatchSize());
        }
    }

    private void stopFlush() {
        isFlushRunning = false;
    }

    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);
            }
            flushMessages(tempFlushMessages);
            tempFlushMessages.clear();
        } catch (InterruptedException ex) {
            Thread.currentThread().interrupt();
        } finally {
            logDebug("[flushInternal] end");
        }
    }

    private void flushMessages(final List<InternalWriteMessage> messages) {
        try {
            logDebug("[flushMessages] start");
            internalLock.lock();
            if (!isFlushRunning || isClosing) {
                return;
            }

            for (InternalWriteMessage message : messages) {
                long writeTime = System.currentTimeMillis();
                message.setWriteTime(writeTime);
                mainAppender.writeBytes(message);
            }
        } finally {
            internalLock.unlock();
            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);
        String useMessageKey = messageKey == null ? UUID.randomUUID().toString() : messageKey;
        internalWriteMessage.setMessageKey(useMessageKey);
        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.
     */
    public boolean isClosed() {
        return isClosed;
    }

    @Override
    public void close() {
        try {
            logDebug("[close] start");
            if (isClosed) {
                logDebug("[close] already closed");
                return;
            }
            isClosing = true;
            internalLock.lock();
            stopFlush();
            internalLock.unlock();
            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 = 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) {
        if (logger.isDebugEnabled()) {
            logDebug(format);
        }
    }

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

    // 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.UUID;
24	import java.util.concurrent.*;
25	import java.util.concurrent.locks.Lock;
26	import java.util.concurrent.locks.ReentrantLock;
27
28	/**
29	* simple writer
30	*
31	* @author frank
32	*/
33	public class SimpleProducer implements IProducer {
34
35	private final Logger logger = LoggerFactory.getLogger(this.getClass());	1✔
36	private final RollCycle defaultRollCycle;
37	private final TimeProvider timeProvider;
38	private final SimpleProducerConfig config;
39	private final SingleChronicleQueue queue;
40	private final LinkedBlockingQueue<InternalWriteMessage> messageCache = new LinkedBlockingQueue<>();	1✔
41	// should only call by flushExecutor
42	private final ExcerptAppender mainAppender;
43	private final ExecutorService flushExecutor = Executors.newSingleThreadExecutor();	1✔
44	private final ScheduledExecutorService scheduler = Executors.newScheduledThreadPool(1);	1✔
45	private final DateTimeFormatter dateFormatter = DateTimeFormatter.ofPattern("yyyyMMdd");	1✔
46	private final Lock internalLock = new ReentrantLock();	1✔
47	private final ConcurrentLinkedQueue<CloseListener> closeListeners = new ConcurrentLinkedQueue<>();	1✔
48
49	private volatile boolean isFlushRunning = true;	1✔
50	private volatile boolean isClosing = false;	1✔
51	private volatile boolean isClosed = false;	1✔
52
53	public SimpleProducer(final SimpleProducerConfig config) {	1✔
54	this.config = config;	1✔
55	this.timeProvider = ChronicleQueueHelper.getTimeProvider(config.getTimeZone());	1✔
56	this.defaultRollCycle = ChronicleQueueHelper.getRollCycle(config.getRollCycleType());	1✔
57	this.queue = ChronicleQueue.singleBuilder(config.getDataDir())	1✔
58	.rollCycle(defaultRollCycle)	1✔
59	.timeProvider(timeProvider)	1✔
60	.build();	1✔
61	this.mainAppender = initMainAppender();	1✔
62	flushExecutor.execute(this::flush);	1✔
63	scheduler.scheduleAtFixedRate(() -> cleanUpOldFiles(config.getKeepDays()), 0, 1, TimeUnit.HOURS);	1✔
64	}	1✔
65
66	private ExcerptAppender initMainAppender() {
67	return CompletableFuture.supplyAsync(this.queue::createAppender, this.flushExecutor).join();	1✔
68	}
69
70	// region flush to file
71	private void flush() {
72	while (isFlushRunning && !isClosing) {	1✔
73	flushMessages(config.getFlushBatchSize());	1✔
74	}
75	}	1✔
76
77	private void stopFlush() {
78	isFlushRunning = false;	1✔
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	flushMessages(tempFlushMessages);	1✔
97	tempFlushMessages.clear();	1✔
98	} catch (InterruptedException ex) {	×
99	Thread.currentThread().interrupt();	×
100	} finally {
101	logDebug("[flushInternal] end");	1✔
102	}	1✔
103	}	1✔
104
105	private void flushMessages(final List<InternalWriteMessage> messages) {
106	try {
107	logDebug("[flushMessages] start");	1✔
108	internalLock.lock();	1✔
109	if (!isFlushRunning \|\| isClosing) {	1✔
110	return;	×
111	}
112
113	for (InternalWriteMessage message : messages) {	1✔
114	long writeTime = System.currentTimeMillis();	1✔
115	message.setWriteTime(writeTime);	1✔
116	mainAppender.writeBytes(message);	1✔
117	}	1✔
118	} finally {
119	internalLock.unlock();	1✔
120	logDebug("[flushMessages] end");	1✔
121	}	1✔
122	}	1✔
123
124	// endregion
125
126
127	@Override
128	public boolean offer(String message) {
129	return offer(null, message);	1✔
130	}
131
132	@Override
133	public boolean offer(String messageKey, String message) {
134	InternalWriteMessage internalWriteMessage = new InternalWriteMessage();	1✔
135	internalWriteMessage.setContent(message);	1✔
136	String useMessageKey = messageKey == null ? UUID.randomUUID().toString() : messageKey;	1✔
137	internalWriteMessage.setMessageKey(useMessageKey);	1✔
138	return this.messageCache.offer(internalWriteMessage);	1✔
139	}
140
141	/**
142	* get the last position
143	*
144	* @return this last position
145	*/
146	public long getLastPosition() {
147	return this.queue.lastIndex();	1✔
148	}
149
150	// region close
151
152	/**
153	* is closed.
154	*
155	* @return true if the Producer is closed, false otherwise.
156	*/
157	public boolean isClosed() {
158	return isClosed;	1✔
159	}
160
161	@Override
162	public void close() {
163	try {
164	logDebug("[close] start");	1✔
165	if (isClosed) {	1✔
NEW 166	logDebug("[close] already closed");	×
NEW 167	return;	×
168	}
169	isClosing = true;	1✔
170	internalLock.lock();	1✔
171	stopFlush();	1✔
172	internalLock.unlock();	1✔
173	if (!queue.isClosed()) {	1✔
174	queue.close();	1✔
175	}
176	flushExecutor.shutdown();	1✔
177	scheduler.shutdown();	1✔
178	try {
179	if (!scheduler.awaitTermination(1, TimeUnit.SECONDS)) {	1✔
180	scheduler.shutdownNow();	×
181	}
182	if (!flushExecutor.awaitTermination(1, TimeUnit.SECONDS)) {	1✔
183	flushExecutor.shutdownNow();	×
184	}
185	} catch (InterruptedException e) {	×
186	scheduler.shutdownNow();	×
187	flushExecutor.shutdownNow();	×
188	Thread.currentThread().interrupt();	×
189	}	1✔
190	for (CloseListener closeListener : closeListeners) {	1✔
191	closeListener.onClose();	1✔
192	}	1✔
193	isClosed = true;	1✔
194	} finally {
195	logDebug("[close] end");	1✔
196	}	1✔
197	}	1✔
198
199	@Override
200	public void addCloseListener(CloseListener listener) {
201	closeListeners.add(listener);	1✔
202	}	1✔
203
204	private void cleanUpOldFiles(int keepDays) {
205	if (keepDays == -1) {	1✔
206	// no need clean up old files
207	return;	1✔
208	}
209	logDebug("[cleanUpOldFiles] start");	1✔
210	try {
211	// Assuming .cq4 is the file extension for Chronicle Queue
212	File[] files = config.getDataDir().listFiles((dir, name) -> name.endsWith(".cq4"));	1✔
213	if (files == null \|\| files.length == 0) {	1✔
214	logDebug("[cleanUpOldFiles] no files found");	1✔
215	return;	1✔
216	}
217	LocalDate now = LocalDate.now();	1✔
218	LocalDate keepStartDate = now.minusDays(keepDays);	1✔
219	for (File file : files) {	1✔
220	cleanUpOldFile(file, keepStartDate);	1✔
221	}
222	} catch (Exception ex) {	×
223	logger.error("[cleanUpOldFiles] error", ex);	×
224	} finally {
225	logDebug("[cleanUpOldFiles] end");	1✔
226	}	1✔
227	}	1✔
228
229	private void cleanUpOldFile(final File file, final LocalDate keepDate) throws IOException {
230	String fileName = file.getName();	1✔
231	String dateString = fileName.substring(0, 8);	1✔
232	LocalDate localDate = LocalDate.parse(dateString, this.dateFormatter);	1✔
233	if (localDate.isBefore(keepDate)) {	1✔
234	Files.deleteIfExists(file.toPath());	1✔
235	logDebug("[cleanUpOldFile] Deleted old file: {}", file.getName());	1✔
236	}
237	}	1✔
238
239	// endregion
240
241	// region logger
242
243	private void logDebug(String format) {
244	if (logger.isDebugEnabled()) {	1✔
245	logDebug(format);	×
246	}
247	}	1✔
248
249	private void logDebug(String format, Object arg) {
250	if (logger.isDebugEnabled()) {	1✔
251	logDebug(format, arg);	×
252	}
253	}	1✔
254
255	// endregion
256	}

wz2cool / local-queue / #38

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