优化注释

5 years ago · 07cb28b484
parent 4e2965ceda
commit 07cb28b484
26 changed files with 415 additions and 434 deletions
--- a/opsli-plugins/opsli-plugins-ehcache/src/main/java/org/opsli/plugins/cache/EhCachePlugin.java
+++ b/opsli-plugins/opsli-plugins-ehcache/src/main/java/org/opsli/plugins/cache/EhCachePlugin.java
@ -16,36 +16,37 @@
 package org.opsli.plugins.cache;

 /**
- * @BelongsProject: opsli-boot
- * @BelongsPackage: org.opsli.plugins.cache
- * @Author: Parker
- * @CreateTime: 2020-09-16 19:19
- * @Description: EhCache 缓存接口
+ * EhCache 缓存接口
+ *
+ * @author Parker
+ * @date 2020-09-16 11:47
 */
 public interface EhCachePlugin {

    /**
     *  添加缓存数据
-      * @param cacheName
-     *  @param key
-     *  @param value
-     *  @return
+      * @param cacheName 缓存名称
+     *  @param key Key
+     *  @param value 值
+     *  @return boolean
     */
    boolean put(String cacheName, String key, Object value);

    /**
     * 获取缓存数据
-     * @param cacheName
-     * @param key
-     * @return
+     * @param cacheName 缓存名称
+     * @param key Key
+     * @param vClass Class
+     * @return V
     */
-    <V> V get(String cacheName, String key ,Class<V> vClass);
+    <V> V get(String cacheName, String key, Class<V> vClass);


    /**
     * 删除缓存数据
-     * @param cacheName
-     * @param key
+     * @param cacheName 缓存名
+     * @param key Key
+     * @return boolean
     */
    boolean delete(String cacheName, String key);

--- a/opsli-plugins/opsli-plugins-ehcache/src/main/java/org/opsli/plugins/cache/conf/EhCacheConfig.java
+++ b/opsli-plugins/opsli-plugins-ehcache/src/main/java/org/opsli/plugins/cache/conf/EhCacheConfig.java
@ -20,11 +20,10 @@ import org.springframework.cache.annotation.EnableCaching;
 import org.springframework.context.annotation.Configuration;

 /**
- * @BelongsProject: opsli-boot
- * @BelongsPackage: org.opsli.plugins.cache.conf
- * @Author: Parker
- * @CreateTime: 2020-09-16 21:35
- * @Description: EhCache
+ * EhCache 配置类
+ *
+ * @author Parker
+ * @date 2020-09-16 11:47
 */
@Configuration
@EnableCaching
--- a/opsli-plugins/opsli-plugins-ehcache/src/main/java/org/opsli/plugins/cache/msg/EhCacheMsg.java
+++ b/opsli-plugins/opsli-plugins-ehcache/src/main/java/org/opsli/plugins/cache/msg/EhCacheMsg.java
@ -18,11 +18,10 @@ package org.opsli.plugins.cache.msg;
 import org.opsli.common.base.msg.BaseMsg;

 /**
- * @BelongsProject: opsli-boot
- * @BelongsPackage: org.opsli.plugins.mail.msg
- * @Author: Parker
- * @CreateTime: 2020-09-13 19:54
- * @Description: 邮件消息
+ * Ehcache 消息
+ *
+ * @author Parker
+ * @date 2020-09-16 11:47
 */
 public enum EhCacheMsg implements BaseMsg {

--- a/opsli-plugins/opsli-plugins-ehcache/src/main/java/org/opsli/plugins/cache/service/EhCachePluginImpl.java
+++ b/opsli-plugins/opsli-plugins-ehcache/src/main/java/org/opsli/plugins/cache/service/EhCachePluginImpl.java
@ -27,11 +27,10 @@ import org.springframework.stereotype.Service;


 /**
- * @BelongsProject: opsli-boot
- * @BelongsPackage: org.opsli.plugins.cache.service
- * @Author: Parker
- * @CreateTime: 2020-09-16 21:08
- * @Description: EhCachePlugin 实现类
+ * EhCachePlugin 实现类
+ *
+ * @author Parker
+ * @date 2020-09-16 11:47
 */
@Slf4j
@Service
--- a/opsli-plugins/opsli-plugins-excel/src/main/java/org/opsli/plugins/excel/ExcelPlugin.java
+++ b/opsli-plugins/opsli-plugins-excel/src/main/java/org/opsli/plugins/excel/ExcelPlugin.java
@ -44,7 +44,9 @@ import java.util.List;
 * 基于easyExcel的开源框架，poi版本3.17
 * BeanCopy ExcelException 属于自定义数据，属于可自定义依赖
 * 工具类尽可能还是需要减少对其他java的包的依赖
- * @author parker
+ *
+ * @author Parker
+ * @date 2020-09-16 11:47
 */
@Slf4j
 public class ExcelPlugin {
@ -249,7 +251,7 @@ public class ExcelPlugin {
     * @param excelListener new ExcelListener()
     */
    private ExcelReader getReader(MultipartFile excel,
-                                         ExcelListener excelListener) throws ExcelPluginException{
+                                         ExcelListener<?> excelListener) throws ExcelPluginException{
        String fileName = excel.getOriginalFilename();
        if (fileName == null ) {
            // 文件格式错误
--- a/opsli-plugins/opsli-plugins-excel/src/main/java/org/opsli/plugins/excel/annotation/CellFontFormat.java
+++ b/opsli-plugins/opsli-plugins-excel/src/main/java/org/opsli/plugins/excel/annotation/CellFontFormat.java
@ -19,9 +19,10 @@ import org.apache.poi.ss.usermodel.IndexedColors;

 import java.lang.annotation.*;
 /**
- * Created Date by 2020/5/9 0009.
+ * 字体格式化
 *
 * @author Parker
+ * @date 2020-09-16 11:47
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
--- a/opsli-plugins/opsli-plugins-excel/src/main/java/org/opsli/plugins/excel/annotation/CellStyleFormat.java
+++ b/opsli-plugins/opsli-plugins-excel/src/main/java/org/opsli/plugins/excel/annotation/CellStyleFormat.java
@ -21,11 +21,10 @@ import org.apache.poi.ss.usermodel.IndexedColors;
 import java.lang.annotation.*;

 /**
- * Created Date by 2020/5/9 0009.
- *
 * Excel 样式注解
 *
- * @author parker
+ * @author Parker
+ * @date 2020-09-16 11:47
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
--- a/opsli-plugins/opsli-plugins-excel/src/main/java/org/opsli/plugins/excel/annotation/ExcelInfo.java
+++ b/opsli-plugins/opsli-plugins-excel/src/main/java/org/opsli/plugins/excel/annotation/ExcelInfo.java
@ -18,13 +18,10 @@ package org.opsli.plugins.excel.annotation;
 import java.lang.annotation.*;

 /**
- * @BelongsProject: opsli-boot
- * @BelongsPackage: org.opsli.common.annotation
- * @Author: Parker
- * @CreateTime: 2020-09-16 16:36
- * @Description: 字典标示
-
+ * Excel 字典标示
 *
+ * @author Parker
+ * @date 2020-09-16 11:47
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@ -33,10 +30,7 @@ public @interface ExcelInfo {

    /** 字典类型 code */
    String dictType() default "";
-    /** 字段反射类型 */
-    //Class<?> reflectFieldType() default Class.class;
-    /** 字段反射名称 */
-    //String reflectFieldName() default "";
+
    /** 字段样式 */
    CellStyleFormat cellStyleFormat() default @CellStyleFormat();

--- a/opsli-plugins/opsli-plugins-excel/src/main/java/org/opsli/plugins/excel/exception/ExcelPluginException.java
+++ b/opsli-plugins/opsli-plugins-excel/src/main/java/org/opsli/plugins/excel/exception/ExcelPluginException.java
@ -19,10 +19,10 @@ import org.opsli.common.base.msg.BaseMsg;
 import org.opsli.common.exception.ServiceException;

 /**
- * Created Date by 2020/5/9 0009.
- *
 * Excel 异常类
+ *
 * @author Parker
+ * @date 2020-09-16 11:47
 */
 public class ExcelPluginException extends ServiceException {

--- a/opsli-plugins/opsli-plugins-excel/src/main/java/org/opsli/plugins/excel/factory/ExcelWriterFactory.java
+++ b/opsli-plugins/opsli-plugins-excel/src/main/java/org/opsli/plugins/excel/factory/ExcelWriterFactory.java
@ -25,12 +25,13 @@ import java.io.OutputStream;
 import java.util.List;

 /**
- * ExcelWriterFactory
+ * Excel 写工厂
 *
- * @author parker
+ * @author Parker
+ * @date 2020-09-16 11:47
 */
 public class ExcelWriterFactory extends ExcelWriter {
-    private OutputStream outputStream;
+    private final OutputStream outputStream;
    private int sheetNo = 1;

    public ExcelWriterFactory(OutputStream outputStream, ExcelTypeEnum typeEnum) {
--- a/opsli-plugins/opsli-plugins-excel/src/main/java/org/opsli/plugins/excel/listener/BatchExcelListener.java
+++ b/opsli-plugins/opsli-plugins-excel/src/main/java/org/opsli/plugins/excel/listener/BatchExcelListener.java
@ -27,7 +27,9 @@ import java.util.List;

 /**
 * Excel 监听
- * @author parker
+ *
+ * @author Parker
+ * @date 2020-09-16 11:47
 */
@Slf4j
 public abstract class BatchExcelListener<T> extends AnalysisEventListener<T> {
--- a/opsli-plugins/opsli-plugins-excel/src/main/java/org/opsli/plugins/excel/listener/ExcelListener.java
+++ b/opsli-plugins/opsli-plugins-excel/src/main/java/org/opsli/plugins/excel/listener/ExcelListener.java
@ -28,7 +28,9 @@ import java.util.List;

 /**
 * Excel 监听
- * @author parker
+ *
+ * @author Parker
+ * @date 2020-09-16 11:47
 */
@Slf4j
 public class ExcelListener<T> extends AnalysisEventListener<T> {
--- a/opsli-plugins/opsli-plugins-excel/src/main/java/org/opsli/plugins/excel/msg/ExcelMsg.java
+++ b/opsli-plugins/opsli-plugins-excel/src/main/java/org/opsli/plugins/excel/msg/ExcelMsg.java
@ -18,11 +18,10 @@ package org.opsli.plugins.excel.msg;
 import org.opsli.common.base.msg.BaseMsg;

 /**
- * @BelongsProject: opsli-boot
- * @BelongsPackage: org.opsli.plugins.mail.msg
- * @Author: Parker
- * @CreateTime: 2020-09-13 19:54
- * @Description: Excel 消息
+ * Excel 消息
+ *
+ * @author Parker
+ * @date 2020-09-16 11:47
 */
 public enum ExcelMsg implements BaseMsg {

--- a/opsli-plugins/opsli-plugins-redis/src/main/java/org/opsli/plugins/redis/RedisLockPlugins.java
+++ b/opsli-plugins/opsli-plugins-redis/src/main/java/org/opsli/plugins/redis/RedisLockPlugins.java
@ -18,18 +18,17 @@ package org.opsli.plugins.redis;
 import org.opsli.plugins.redis.lock.RedisLock;

 /**
- * @BelongsProject: opsli-boot
- * @BelongsPackage: org.opsli.plugins.redis
- * @Author: Parker
- * @CreateTime: 2020-09-16 11:47
- * @Description: Redis 锁 接口
+ * Redis 锁 接口
+ *
+ * @author Parker
+ * @date 2020-09-16 11:47
 */
 public interface RedisLockPlugins {

    /**
     * 尝试锁
     * @param redisLock redis锁参数
-     * @return
+     * @return RedisLock
     */
    RedisLock tryLock(RedisLock redisLock);

@ -37,7 +36,7 @@ public interface RedisLockPlugins {
    /**
     * 释放锁
     * @param redisLock redis锁参数
-     * @return
+     * @return boolean
     */
    boolean unLock(RedisLock redisLock);
 }
--- a/opsli-plugins/opsli-plugins-redis/src/main/java/org/opsli/plugins/redis/RedisPlugin.java
+++ b/opsli-plugins/opsli-plugins-redis/src/main/java/org/opsli/plugins/redis/RedisPlugin.java
--- a/opsli-plugins/opsli-plugins-redis/src/main/java/org/opsli/plugins/redis/conf/RedisPluginConfig.java
+++ b/opsli-plugins/opsli-plugins-redis/src/main/java/org/opsli/plugins/redis/conf/RedisPluginConfig.java
@ -35,10 +35,10 @@ import java.nio.charset.StandardCharsets;
 import java.util.List;

 /**
- * @Author parker
- *
 * Redis 配置类
 *
+ * @author Parker
+ * @date 2020-09-16 11:47
 */
@Slf4j
@Configuration
--- a/opsli-plugins/opsli-plugins-redis/src/main/java/org/opsli/plugins/redis/exception/RedisPluginException.java
+++ b/opsli-plugins/opsli-plugins-redis/src/main/java/org/opsli/plugins/redis/exception/RedisPluginException.java
@ -19,11 +19,10 @@ import org.opsli.common.base.msg.BaseMsg;
 import org.opsli.common.exception.ServiceException;

 /**
- * @BelongsProject: opsli-boot
- * @BelongsPackage: org.opsli.plugins.mail.exception
- * @Author: Parker
- * @CreateTime: 2020-09-14 18:44
- * @Description: Redis 异常
+ * Redis 异常
+ *
+ * @author Parker
+ * @date 2020-09-16 11:47
 */
 public class RedisPluginException extends ServiceException {

--- a/opsli-plugins/opsli-plugins-redis/src/main/java/org/opsli/plugins/redis/lock/RedisLock.java
+++ b/opsli-plugins/opsli-plugins-redis/src/main/java/org/opsli/plugins/redis/lock/RedisLock.java
@ -19,11 +19,10 @@ package org.opsli.plugins.redis.lock;
 import java.util.concurrent.atomic.AtomicInteger;

 /**
- * @BelongsProject: opsli-boot
- * @BelongsPackage: org.opsli.plugins.redis.lock
- * @Author: Parker
- * @CreateTime: 2020-09-16 00:51
- * @Description: Redis 锁
+ * Redis 锁
+ *
+ * @author Parker
+ * @date 2020-09-16 11:47
 */
 public class RedisLock {

--- a/opsli-plugins/opsli-plugins-redis/src/main/java/org/opsli/plugins/redis/lock/RedisLockImpl.java
+++ b/opsli-plugins/opsli-plugins-redis/src/main/java/org/opsli/plugins/redis/lock/RedisLockImpl.java
@ -28,11 +28,7 @@ import java.util.Collections;
 import java.util.List;

 /**
- * @BelongsProject: opsli-boot
- * @BelongsPackage: org.opsli.plugins.redis.lock
- * @Author: Parker
- * @CreateTime: 2020-09-16 11:49
- * @Description: Redis 锁实现
+ * Redis 锁实现
 *
 * ===================== Redis 锁相关 =====================
 *
@ -47,6 +43,8 @@ import java.util.List;
 * 2、这把锁只能是非阻塞的，无论成功还是失败都直接返回。
 * 3、这把锁是非重入的，一个线程获得锁之后，在释放锁之前，无法再次获得该锁，因为使用到的key在tair中已经存在。无法再执行put操作。
 *
+ * @author Parker
+ * @date 2020-09-16 11:47
 */
@Slf4j
@Service
--- a/opsli-plugins/opsli-plugins-redis/src/main/java/org/opsli/plugins/redis/msg/RedisMsg.java
+++ b/opsli-plugins/opsli-plugins-redis/src/main/java/org/opsli/plugins/redis/msg/RedisMsg.java
@ -18,11 +18,10 @@ package org.opsli.plugins.redis.msg;
 import org.opsli.common.base.msg.BaseMsg;

 /**
- * @BelongsProject: opsli-boot
- * @BelongsPackage: org.opsli.plugins.mail.msg
- * @Author: Parker
- * @CreateTime: 2020-09-13 19:54
- * @Description: Redis消息
+ * Redis消息
+ *
+ * @author Parker
+ * @date 2020-09-16 11:47
 */
 public enum RedisMsg implements BaseMsg {

--- a/opsli-plugins/opsli-plugins-redis/src/main/java/org/opsli/plugins/redis/pushsub/entity/BaseSubMessage.java
+++ b/opsli-plugins/opsli-plugins-redis/src/main/java/org/opsli/plugins/redis/pushsub/entity/BaseSubMessage.java
@ -21,13 +21,12 @@ import lombok.experimental.Accessors;
 import org.opsli.common.enums.SystemInfo;

 /**
- * @author parker
- * @date 2020-09-13
- *
 * 广播消息时，不会处理 自身的数据，如果要处理请预先处理
 *
 * 防止广播数据处理到自身时出现延迟问题
 *
+ * @author Parker
+ * @date 2020-09-16 11:47
 */
@Data
@Accessors(chain = true)
--- a/opsli-plugins/opsli-plugins-redis/src/main/java/org/opsli/plugins/redis/pushsub/entity/RedisPushSubMessage.java
+++ b/opsli-plugins/opsli-plugins-redis/src/main/java/org/opsli/plugins/redis/pushsub/entity/RedisPushSubMessage.java
@ -18,11 +18,10 @@ package org.opsli.plugins.redis.pushsub.entity;
 import java.io.Serializable;

 /**
- * @BelongsProject: opsli-boot
- * @BelongsPackage: org.opsli.plugins.redis.entity
- * @Author: Parker
- * @CreateTime: 2020-09-15 14:50
- * @Description: Redis 消息订阅
+ * Redis 消息订阅
+ *
+ * @author Parker
+ * @date 2020-09-16 11:47
 */
 public interface RedisPushSubMessage extends Serializable {

--- a/opsli-plugins/opsli-plugins-redis/src/main/java/org/opsli/plugins/redis/scripts/RedisScriptCache.java
+++ b/opsli-plugins/opsli-plugins-redis/src/main/java/org/opsli/plugins/redis/scripts/RedisScriptCache.java
@ -22,7 +22,9 @@ import java.util.concurrent.ConcurrentMap;

 /**
 * 脚本缓存
- * @author parker
+ *
+ * @author Parker
+ * @date 2020-09-16 11:47
 */
 public class RedisScriptCache {

--- a/opsli-plugins/opsli-plugins-redis/src/main/java/org/opsli/plugins/redis/scripts/enums/RedisScriptsEnum.java
+++ b/opsli-plugins/opsli-plugins-redis/src/main/java/org/opsli/plugins/redis/scripts/enums/RedisScriptsEnum.java
@ -17,11 +17,10 @@ package org.opsli.plugins.redis.scripts.enums;


 /**
- * @BelongsProject: opsli-boot
- * @BelongsPackage: org.opsli.plugins.redis.enums
- * @Author: Parker
- * @CreateTime: 2020-09-14 21:56
- * @Description: Redis 脚本枚举
+ * Redis 脚本枚举
+ *
+ * @author Parker
+ * @date 2020-09-16 11:47
 */
 public enum RedisScriptsEnum {

--- a/opsli-plugins/opsli-plugins-waf/src/main/java/org/opsli/plugins/waf/msg/WafMsg.java
+++ b/opsli-plugins/opsli-plugins-waf/src/main/java/org/opsli/plugins/waf/msg/WafMsg.java
@ -18,11 +18,10 @@ package org.opsli.plugins.waf.msg;
 import org.opsli.common.base.msg.BaseMsg;

 /**
- * @BelongsProject: opsli-boot
- * @BelongsPackage: org.opsli.plugins.mail.msg
- * @Author: Parker
- * @CreateTime: 2020-09-13 19:54
- * @Description: Excel 消息
+ * 防火墙 消息
+ *
+ * @author Parker
+ * @date 2020-09-16
 */
 public enum WafMsg implements BaseMsg {

--- a/opsli-plugins/opsli-plugins-waf/src/main/java/org/opsli/plugins/waf/properties/WafProperties.java
+++ b/opsli-plugins/opsli-plugins-waf/src/main/java/org/opsli/plugins/waf/properties/WafProperties.java
@ -9,7 +9,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
 import java.util.Set;

 /**
- * 软防火墙
+ * 软防火墙 配置
 *
 * @author Parker
 * @date 2020-12-19