增加注释

src/main/java/com/sumbytes/common/annotation/Explain.java

@@ -6,6 +6,12 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+
+/**
+ * 注释标注.
+ *
+ * @author Young
+ */
 @Target(ElementType.METHOD)
 @Retention(RetentionPolicy.RUNTIME)
 public @interface Explain {

src/main/java/com/sumbytes/common/annotation/LoginRequired.java

@@ -8,10 +8,9 @@ import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
 /**
- * @author: zsg
- * @description:
- * @date: 2019/8/28 23:02
- * @modified:
+ * 登录校验注解.
+ *
+ * @author Young
  */
 @Target({ElementType.METHOD, ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)

src/main/java/com/sumbytes/common/annotation/OperateLog.java

@@ -7,13 +7,27 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+
+/**
+ * 操作日志.
+ *
+ * @author Young
+ */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.METHOD)
 public @interface OperateLog {
 
-    // 模块名
-    String  module();
-    
-    // 操作编号
+    /**
+     * 模块名
+     *
+     * @return 模块名称
+     */
+    String module();
+
+    /**
+     * 操作编号
+     *
+     * @return 操作编号
+     */
     OperateEnum code() default OperateEnum.GET_POSTS_DEFAULT;
 }

src/main/java/com/sumbytes/common/base/dao/BaseDao.java

@@ -1,17 +1,12 @@
 package com.sumbytes.common.base.dao;
 
-import com.baomidou.mybatisplus.core.conditions.Wrapper;
 import com.baomidou.mybatisplus.core.mapper.BaseMapper;
-import com.baomidou.mybatisplus.core.toolkit.Constants;
-import org.apache.ibatis.annotations.Param;
 
+/**
+ * DAO 层抽象父类.
+ *
+ * @param <T> 泛型
+ * @author Young
+ */
 public interface BaseDao<T> extends BaseMapper<T> {
-
-    /**
-     * 逻辑删除
-     * @param entity
-     * @param updateWrapper
-     * @return
-     */
-    int logicDeleteByWrapper(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper<T> updateWrapper);
 }

src/main/java/com/sumbytes/common/base/domain/Result.java

@@ -12,25 +12,56 @@ import java.util.List;
 /**
  * 用于向前端返回统一的结果对象
  *
- * @param <T>
+ * @param <T> 实体类型
+ * @author Young
  */
 @Data
 @Accessors(chain = true)
 public class Result<T> {
 
-    private int success = 0; // 操作标识，标记
-    private String resultCode; // 结果编码
-    private String message; // 提示信息
-    private T model; // 结果对象
-    private List<T> models; // 结果集对象
-    private PageInfo pageInfo; // 分页信息对象
-    private Object extra; // 扩展字段
-
-    // 禁止空参构造
+    /**
+     * 操作标识，标记
+     */
+    private int success = 0;
+    /**
+     * 结果编码
+     */
+    private String resultCode;
+
+    /**
+     * 提示信息
+     */
+    private String message;
+
+    /**
+     * 结果对象
+     */
+    private T model;
+
+    /**
+     * 结果集对象
+     */
+    private List<T> models;
+
+    /**
+     * 分页信息对象
+     */
+    private PageInfo pageInfo;
+
+    /**
+     * 扩展字段
+     */
+    private Object extra;
+
+    /**
+     * 禁止空参构造
+     */
     private Result() {
     }
 
-    // 通过操作标识及提示信息构建结果对象
+    /**
+     * 通过操作标识及提示信息构建结果对象
+     */
     private static <T> Result<T> createWithSuccessFlag(int success) {
         Result result = new Result();
         result.setSuccess(success);

src/main/java/com/sumbytes/common/base/domain/vo/BaseVO.java

@@ -9,9 +9,10 @@ import lombok.Data;
 import lombok.experimental.Accessors;
 
 /**
- * @Description:
- * @Author:sumbytes
- * @Date:2018/09/21 13:30
+ * VO 层基础父类.
+ *
+ * @param <T> VO类型
+ * @author Young
  */
 @Data
 @Accessors(chain = true)
@@ -20,7 +21,7 @@ public class BaseVO<T> {
     /**
      * 主键
      */
-    @NotNull(message = Messages.ID_NOT_NULL,groups = {Update.class})
+    @NotNull(message = Messages.ID_NOT_NULL, groups = {Update.class})
     protected Long id;
 
     /**
@@ -31,13 +32,13 @@ public class BaseVO<T> {
     /**
      * 页数
      */
-    @IntegerNotNull(groups = {Page.class},message = Messages.PAGE_NOT_NULL)
+    @IntegerNotNull(groups = {Page.class}, message = Messages.PAGE_NOT_NULL)
     protected Integer page;
 
     /**
      * 每页大小
      */
-    @IntegerNotNull(groups = {Page.class},message = Messages.SIZE_NOT_NULL)
+    @IntegerNotNull(groups = {Page.class}, message = Messages.SIZE_NOT_NULL)
     protected Integer size;
 
     public Long getId() {
@@ -53,9 +54,10 @@ public class BaseVO<T> {
         return size;
     }
 
-    public BaseVO<T> setSize(Integer size) {
+
+    public T setSize(Integer size) {
         this.size = size > 20 ? 20 : size;
-        return this;
+        return (T) this;
     }
 
 }

src/main/java/com/sumbytes/common/base/domain/vo/UserSessionVO.java

@@ -4,9 +4,9 @@ import lombok.Data;
 import lombok.experimental.Accessors;
 
 /**
- * @Description:
- * @Author:sumbytes
- * @Date:2018/09/20 16:58
+ * 用户 Session 实体.
+ *
+ * @author Young
  */
 @Data
 @Accessors(chain = true)