docs(项目): 完善代码注释

src/main/java/com/wayn/common/annotation/Log.java

@@ -7,6 +7,9 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+/**
+ * 日志注解
+ */
 @Target(ElementType.METHOD)
 @Retention(RetentionPolicy.RUNTIME)
 public @interface Log {

src/main/java/com/wayn/common/base/BaseController.java

@@ -16,6 +16,9 @@ import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import javax.servlet.http.HttpSession;
 
+/**
+ * 基础控制器类，获得通用的参数封装、返回值封装方法
+ */
 @Slf4j
 public class BaseController {
 

src/main/java/com/wayn/common/base/BaseEntity.java

@@ -9,6 +9,9 @@ import lombok.Data;
 import java.io.Serializable;
 import java.util.Date;
 
+/**
+ * 基础entity类，集成以获取通用字段
+ */
 @Data
 public class BaseEntity implements Serializable {
     private static final long serialVersionUID = 1956057929467119856L;

src/main/java/com/wayn/common/base/CommonController.java

@@ -6,8 +6,7 @@ import com.wayn.common.util.file.FileUploadUtil;
 import com.wayn.common.util.file.FileUtils;
 import com.wayn.common.util.http.HttpUtil;
 import com.wayn.framework.config.WaynConfig;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import lombok.extern.slf4j.Slf4j;
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PostMapping;
@@ -20,14 +19,14 @@ import javax.servlet.http.HttpServletResponse;
 import java.io.File;
 
 /**
- * 通用请求处理
+ * 通用请求处理类
  *
  * @author ruoyi
  */
+@Slf4j
 @Controller
 @RequestMapping("common")
 public class CommonController {
-    private static final Logger log = LoggerFactory.getLogger(CommonController.class);
 
     /**
      * 通用下载请求
@@ -36,19 +35,17 @@ public class CommonController {
      * @param delete   是否删除
      */
     @GetMapping("download")
-    public void fileDownload(String fileName, Boolean delete, HttpServletResponse response, HttpServletRequest request) {
+    public void fileDownload(String fileName, boolean delete, HttpServletResponse response, HttpServletRequest request) {
         try {
             if (!FileUtils.isValidFilename(fileName)) {
                 throw new BusinessException("文件名称(" + fileName + ")非法，不允许下载。 ");
             }
-
             String realFileName = System.currentTimeMillis() + fileName.substring(fileName.indexOf("_") + 1);
             String filePath = WaynConfig.getDownloadPath() + fileName;
 
             response.setCharacterEncoding("utf-8");
             response.setContentType("multipart/form-data");
-            response.setHeader("Content-Disposition",
-                    "attachment;fileName=" + FileUtils.setFileDownloadHeader(request, realFileName));
+            response.setHeader("Content-Disposition", "attachment;fileName=" + FileUtils.setFileDownloadHeader(request, realFileName));
             FileUtils.writeBytes(filePath, response.getOutputStream());
             if (delete) {
                 FileUtils.deleteFile(filePath);

src/main/java/com/wayn/common/exception/GlobalExceptionHandler.java

@@ -43,6 +43,16 @@ public class GlobalExceptionHandler {
         return R.error(e.getMessage());
     }
 
+    /**
+     * 自定义验证异常
+     */
+    @ExceptionHandler(MethodArgumentNotValidException.class)
+    public R validExceptionHandler(MethodArgumentNotValidException e) {
+        log.error(e.getMessage(), e);
+        String message = Objects.requireNonNull(e.getBindingResult().getFieldError()).getDefaultMessage();
+        return R.error(message);
+    }
+
     /**
      * 登陆错误异常
      */
@@ -78,14 +88,4 @@ public class GlobalExceptionHandler {
         log.error(e.getMessage(), e);
         return R.error(e.getMessage());
     }
-
-    /**
-     * 自定义验证异常
-     */
-    @ExceptionHandler(MethodArgumentNotValidException.class)
-    public R validExceptionHandler(MethodArgumentNotValidException e) {
-        log.error(e.getMessage(), e);
-        String message = e.getBindingResult().getFieldError().getDefaultMessage();
-        return R.error(message);
-    }
 }

src/main/java/com/wayn/common/util/ParameterUtil.java

@@ -14,7 +14,7 @@ import java.util.Map;
  */
 public class ParameterUtil {
 	private static final String BASE_ENTITY = "BaseEntity";
-	private static ThreadLocal<QueryWrapper> entityWrapperThreadLocal = new ThreadLocal<>();
+	private static final ThreadLocal<QueryWrapper> entityWrapperThreadLocal = new ThreadLocal<>();
 
 	/**
 	 * 设置wrapper类得通用查询属性
@@ -22,7 +22,7 @@ public class ParameterUtil {
 	 * @param <T>
 	 */
 	public static <T> void setWrapper() {
-		QueryWrapper<T> wrapper = new QueryWrapper<T>();
+		QueryWrapper<T> wrapper = new QueryWrapper<>();
 		String startTime = ServletUtils.getParameter("startTime");
 		String endTime = ServletUtils.getParameter("endTime");
 		ServletUtils.setParameter("startTime", startTime);

src/main/java/com/wayn/common/util/excel/ExcelUtil.java

@@ -58,10 +58,8 @@ public class ExcelUtil {
         String filename = ExcelUtil.encodingFilename(originalName);
         try (OutputStream out = new FileOutputStream(ExcelUtil.getAbsoluteFile(filename))) {
             workbook.write(out);
-        } catch (FileNotFoundException e) {
+        } catch (IOException e) {
             log.error(e.getMessage(), e);
-        } catch (IOException exception) {
-            log.error(exception.getMessage(), exception);
         }
         return filename;
     }

src/main/java/com/wayn/common/util/file/FileUploadUtil.java

@@ -8,6 +8,7 @@ import org.springframework.web.multipart.MultipartFile;
 
 import java.io.File;
 import java.io.IOException;
+import java.util.Objects;
 
 /**
  * 文件上传帮助类
@@ -15,14 +16,14 @@ import java.io.IOException;
 public class FileUploadUtil {
 
     public static String uploadFile(MultipartFile file, String filePath) throws IOException {
-        int fileNameLength = file.getOriginalFilename().length();
+        int fileNameLength = Objects.requireNonNull(file.getOriginalFilename()).length();
         if (fileNameLength > 100) {
             throw new BusinessException("文件名称过长");
         }
         String fileName = file.getOriginalFilename();
         String extension = FilenameUtils.getExtension(fileName);
         if (StringUtils.isEmpty(extension)) {
-            extension = MimeTypeUtils.getExtension(file.getContentType());
+            extension = MimeTypeUtils.getExtension(Objects.requireNonNull(file.getContentType()));
         }
         String encodingFilename = FileUtils.encodingFilename(fileName);
         fileName = DateUtils.datePath() + "/" + encodingFilename + "." + extension;

src/main/java/com/wayn/common/util/file/FileUtils.java

@@ -60,7 +60,7 @@ public class FileUtils extends org.apache.commons.io.FileUtils {
      * 删除文件
      *
      * @param filePath 文件
-     * @return
+     * @return boolean
      */
     public static boolean deleteFile(String filePath) {
         boolean flag = false;

src/main/java/com/wayn/common/util/http/HttpUtil.java

@@ -50,7 +50,7 @@ public class HttpUtil {
      * </p>
      *
      * @param request 当前请求
-     * @return
+     * @return boolean
      */
     public static boolean isAjax(HttpServletRequest request) {
         return "XMLHttpRequest".equals(request.getHeader("X-Requested-With"));
@@ -299,12 +299,12 @@ public class HttpUtil {
                 request.getContextPath();
     }
 
-    public static String getValueByCookie(HttpServletRequest request) {
+    public static String getValueByCookie(String key, HttpServletRequest request) {
         String value = "";
         Cookie[] cookies = request.getCookies();
         if (Objects.nonNull(cookies)) {
             for (Cookie cookie : cookies) {
-                if (cookie.getName().equals("token")) {
+                if (cookie.getName().equals(key)) {
                     value = cookie.getValue();
                     break;
                 }

src/main/java/com/wayn/common/util/jwt/JwtUtil.java

@@ -36,8 +36,8 @@ public class JwtUtil {
     /**
      * 获取签发时间
      *
-     * @param token
-     * @return
+     * @param token token
+     * @return 签发时间
      */
     public static Date getIssuedAt(String token) {
         try {

src/main/java/com/wayn/framework/config/MybatisPlusConfig.java

@@ -8,7 +8,6 @@ import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.EnableAspectJAutoProxy;
 import org.springframework.transaction.annotation.EnableTransactionManagement;
 
-//Spring boot方式
 @EnableTransactionManagement
 @EnableAspectJAutoProxy
 @Configuration

src/main/java/com/wayn/project/system/domain/SysUser.java

@@ -15,6 +15,9 @@ import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.Size;
 import java.util.List;
 
+/**
+ * 用户表 sys_user
+ */
 @Data
 @ApiModel("用户实体")
 @EqualsAndHashCode(callSuper = true)