wz2cool / local-queue / #48

Committed 03 Feb 2025 12:40PM UTC coverage: 91.935% (+0.09%) from 91.85%

Build # #48

Build Type

push

Committed by

Commit Message

Merge pull request #7 from wz2cool/0.1.3

0.1.3

Run Details

221 of 248 new or added lines in 7 files covered. (89.11%)

5 existing lines in 2 files now uncovered.

684 of 744 relevant lines covered (91.94%)

0.92 hits per line

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

86.99

/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
 */
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();
        } 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);
    }

    /**
     * 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() {
        synchronized (closeLocker) {
            try {
                logDebug("[close] start");
                if (isClosing.get()) {
                    logDebug("[close] is closing");
                    return;
                }
                isClosing.set(true);
                stopFlush();
                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	public class SimpleProducer implements IProducer {
32
33	private final Logger logger = LoggerFactory.getLogger(this.getClass());	1✔
34	private final RollCycle defaultRollCycle;
35	private final TimeProvider timeProvider;
36	private final SimpleProducerConfig config;
37	private final SingleChronicleQueue queue;
38	private final LinkedBlockingQueue<InternalWriteMessage> messageCache = new LinkedBlockingQueue<>();	1✔
39	// should only call by flushExecutor
40	private final ExcerptAppender mainAppender;
41	private final ExecutorService flushExecutor = Executors.newSingleThreadExecutor();	1✔
42	private final ScheduledExecutorService scheduler = Executors.newScheduledThreadPool(1);	1✔
43	private final DateTimeFormatter dateFormatter = DateTimeFormatter.ofPattern("yyyyMMdd");	1✔
44	private final ConcurrentLinkedQueue<CloseListener> closeListeners = new ConcurrentLinkedQueue<>();	1✔
45
46	private final AtomicBoolean isFlushRunning = new AtomicBoolean(true);	1✔
47	private final AtomicBoolean isClosing = new AtomicBoolean(false);	1✔
48	private final AtomicBoolean isClosed = new AtomicBoolean(false);	1✔
49	private final Object closeLocker = new Object();	1✔
50
51	public SimpleProducer(final SimpleProducerConfig config) {	1✔
52	this.config = config;	1✔
53	this.timeProvider = ChronicleQueueHelper.getTimeProvider(config.getTimeZone());	1✔
54	this.defaultRollCycle = ChronicleQueueHelper.getRollCycle(config.getRollCycleType());	1✔
55	this.queue = ChronicleQueue.singleBuilder(config.getDataDir())	1✔
56	.rollCycle(defaultRollCycle)	1✔
57	.timeProvider(timeProvider)	1✔
58	.build();	1✔
59	this.mainAppender = initMainAppender();	1✔
60	flushExecutor.execute(this::flush);	1✔
61	scheduler.scheduleAtFixedRate(() -> cleanUpOldFiles(config.getKeepDays()), 0, 1, TimeUnit.HOURS);	1✔
62	}	1✔
63
64	private ExcerptAppender initMainAppender() {
65	return CompletableFuture.supplyAsync(this.queue::createAppender, this.flushExecutor).join();	1✔
66	}
67
68	// region flush to file
69
70	private void stopFlush() {
71	isFlushRunning.set(false);	1✔
72	}	1✔
73
74	private void flush() {
75	while (isFlushRunning.get() && !isClosing.get()) {	1✔
76	flushMessages(config.getFlushBatchSize());	1✔
77	}
78	}	1✔
79
80	private final List<InternalWriteMessage> tempFlushMessages = new ArrayList<>();	1✔
81
82	private void flushMessages(int batchSize) {
83	try {
84	logDebug("[flushInternal] start");	1✔
85	if (tempFlushMessages.isEmpty()) {	1✔
86	// take 主要作用就是卡主线程
87	InternalWriteMessage firstItem = this.messageCache.poll(config.getFlushInterval(), TimeUnit.MILLISECONDS);	1✔
88	if (firstItem == null) {	1✔
89	return;	1✔
90	}
91	this.tempFlushMessages.add(firstItem);	1✔
92	// 如果空了从消息缓存放入待刷消息
93	this.messageCache.drainTo(tempFlushMessages, batchSize - 1);	1✔
94	}
95	doFlushMessages(tempFlushMessages);	1✔
96	tempFlushMessages.clear();	1✔
97	} catch (InterruptedException ex) {	×
98	Thread.currentThread().interrupt();	×
99	} finally {
100	logDebug("[flushInternal] end");	1✔
101	}	1✔
102	}	1✔
103
104	private void doFlushMessages(final List<InternalWriteMessage> messages) {
105	synchronized (closeLocker) {	1✔
106	try {
107	logDebug("[flushMessages] start");	1✔
108	if (isClosing.get()) {	1✔
NEW 109	logDebug("[flushMessages] producer is closing");	×
NEW 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	logDebug("[flushMessages] end");	1✔
120	}	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	internalWriteMessage.setMessageKey(messageKey);	1✔
137	return this.messageCache.offer(internalWriteMessage);	1✔
138	}
139
140	/**
141	* get the last position
142	*
143	* @return this last position
144	*/
145	public long getLastPosition() {
146	return this.queue.lastIndex();	1✔
147	}
148
149	// region close
150
151	/**
152	* is closed.
153	*
154	* @return true if the Producer is closed, false otherwise.
155	*/
156	@Override
157	public boolean isClosed() {
158	return isClosed.get();	1✔
159	}
160
161	@Override
162	public void close() {
163	synchronized (closeLocker) {	1✔
164	try {
165	logDebug("[close] start");	1✔
166	if (isClosing.get()) {	1✔
NEW 167	logDebug("[close] is closing");	×
NEW 168	return;	×
169	}
170	isClosing.set(true);	1✔
171	stopFlush();	1✔
172	if (!queue.isClosed()) {	1✔
173	queue.close();	1✔
174	}
175	flushExecutor.shutdown();	1✔
176	scheduler.shutdown();	1✔
177	try {
178	if (!scheduler.awaitTermination(1, TimeUnit.SECONDS)) {	1✔
NEW 179	scheduler.shutdownNow();	×
180	}
181	if (!flushExecutor.awaitTermination(1, TimeUnit.SECONDS)) {	1✔
NEW 182	flushExecutor.shutdownNow();	×
183	}
NEW 184	} catch (InterruptedException e) {	×
NEW 185	scheduler.shutdownNow();	×
UNCOV 186	flushExecutor.shutdownNow();	×
NEW 187	Thread.currentThread().interrupt();	×
188	}	1✔
189	for (CloseListener closeListener : closeListeners) {	1✔
190	closeListener.onClose();	1✔
191	}	1✔
192	isClosed.set(true);	1✔
193	} finally {
194	logDebug("[close] end");	1✔
195	}	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
230	private void cleanUpOldFile(final File file, final LocalDate keepDate) throws IOException {
231	String fileName = file.getName();	1✔
232	String dateString = fileName.substring(0, 8);	1✔
233	LocalDate localDate = LocalDate.parse(dateString, this.dateFormatter);	1✔
234	if (localDate.isBefore(keepDate)) {	1✔
235	Files.deleteIfExists(file.toPath());	1✔
236	logDebug("[cleanUpOldFile] Deleted old file: {}", file.getName());	1✔
237	}
238	}	1✔
239
240	// endregion
241
242	// region logger
243	private void logDebug(String format, String arg) {
244	if (logger.isDebugEnabled()) {	1✔
NEW 245	logger.debug(format, arg);	×
246	}
247	}	1✔
248
249
250	private void logDebug(String format) {
251	if (logger.isDebugEnabled()) {	1✔
NEW 252	logger.debug(format);	×
253	}
254	}	1✔
255
256	// endregion
257	}

wz2cool / local-queue / #48

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