添加java-doc

novel-common/src/main/java/com/java2nb/novel/common/base/BaseController.java

@@ -9,13 +9,19 @@ import org.springframework.beans.factory.annotation.Autowired;
 import javax.servlet.http.HttpServletRequest;
 
 /**
- * @author 11797
+ * 基础Controller
+ * @author xiongxiaoyang
+ * @version 1.0
+ * @since 2020/5/27
  */
 public class BaseController {
 
     protected JwtTokenUtil jwtTokenUtil;
 
 
+    /**
+     * 获取登陆token
+     * */
     protected String getToken(HttpServletRequest request){
         String token = CookieUtil.getCookie(request,"Authorization");
         if(token != null){
@@ -24,6 +30,9 @@ public class BaseController {
         return request.getHeader("Authorization");
     }
 
+    /**
+     * 获取登陆用户信息
+     * */
     protected UserDetails getUserDetails(HttpServletRequest request) {
         String token = getToken(request);
         if(StringUtils.isBlank(token)){

novel-common/src/main/java/com/java2nb/novel/common/bean/UserDetails.java

@@ -3,7 +3,10 @@ package com.java2nb.novel.common.bean;
 import lombok.Data;
 
 /**
- * @author 11797
+ * 登陆用户信息封装
+ * @author xiongxiaoyang
+ * @version 1.0
+ * @since 2020/5/27
  */
 @Data
 public class UserDetails {

novel-common/src/main/java/com/java2nb/novel/common/cache/CacheKey.java

@@ -1,7 +1,10 @@
 package com.java2nb.novel.common.cache;
 
 /**
- * @author 11797
+ * 缓存key
+ * @author xiongxiaoyang
+ * @version 1.0
+ * @since 2020/5/27
  */
 public interface CacheKey {
 

novel-common/src/main/java/com/java2nb/novel/common/cache/CacheService.java

@@ -1,7 +1,10 @@
 package com.java2nb.novel.common.cache;
 
 /**
- * @author 11797
+ * 缓存服务接口
+ * @author xiongxiaoyang
+ * @version 1.0
+ * @since 2020/5/27
  */
 public interface CacheService {
 

novel-common/src/main/java/com/java2nb/novel/common/cache/impl/RedisServiceImpl.java

@@ -10,7 +10,10 @@ import org.springframework.stereotype.Service;
 import java.util.concurrent.TimeUnit;
 
 /**
- * @author xxy
+ * Redis缓存服务实现
+ * @author xiongxiaoyang
+ * @version 1.0
+ * @since 2020/5/27
  */
 @ConditionalOnProperty(prefix = "spring.redis", name = "host", matchIfMissing = false)
 @RequiredArgsConstructor

novel-common/src/main/java/com/java2nb/novel/common/enums/ResponseStatus.java

@@ -5,9 +5,11 @@ import lombok.Getter;
 import lombok.NoArgsConstructor;
 
 /**
- * @author 11797
+ * 响应状态枚举
+ * @author xiongxiaoyang
+ * @version 1.0
+ * @since 2020/5/27
  */
-
 @Getter
 @AllArgsConstructor
 @NoArgsConstructor

novel-common/src/main/java/com/java2nb/novel/common/utils/Constants.java

@@ -1,8 +1,10 @@
 package com.java2nb.novel.common.utils;
 
 /**
- * 常量类
- * @author Administrator
+ * 常量
+ * @author xiongxiaoyang
+ * @version 1.0
+ * @since 2020/5/27
  */
 public class Constants {
 

novel-common/src/main/java/com/java2nb/novel/common/utils/CookieUtil.java

@@ -5,7 +5,10 @@ import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
 /**
- * @author Administrator
+ * Cookie操作工具类
+ * @author xiongxiaoyang
+ * @version 1.0
+ * @since 2020/5/27
  */
 public class CookieUtil {
 

novel-common/src/main/java/com/java2nb/novel/common/utils/JwtTokenUtil.java

@@ -16,7 +16,10 @@ import java.util.HashMap;
 import java.util.Map;
 
 /**
- * @author 11797
+ * JWT工具类
+ * @author xiongxiaoyang
+ * @version 1.0
+ * @since 2020/5/27
  */
 @Component
 @ConditionalOnProperty(prefix = "jwt", name = "secret")