增加 注释

ch-wx-api/src/main/java/com/wwdz/ch/wx/config/WebMvcConfiguration.java

@@ -11,6 +11,9 @@ import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 
 import java.util.List;
 
+/**
+ * mvc配置
+ */
 @Configuration
 public class WebMvcConfiguration implements WebMvcConfigurer {
 	@Bean
@@ -25,10 +28,15 @@ public class WebMvcConfiguration implements WebMvcConfigurer {
 		argumentResolvers.add(loginUserHandlerMethodArgumentResolver);
 	}
 
+	/**
+	 * 添加自定义拦截器
+	 * @param registry
+	 */
 	@Override
 	public void addInterceptors(InterceptorRegistry registry) {
 		registry.addInterceptor(loginInterceptor())
 				.addPathPatterns("/**")
+				// 放行路径
 				.excludePathPatterns("/*.html", "/**/*.html", "/**/*.css", "/**/*.js"
 						, "/wx/user/loginByWx", "/wx/user/loginByMobile", "/wx/user/loginRegCaptcha", "/wx/user/updateRegCaptcha", "/wx/user/login", "/wx/user/fillCode"
 				);

ch-wx-api/src/main/java/com/wwdz/ch/wx/entity/request/CategoryRequestDto.java

@@ -7,11 +7,18 @@ import java.util.List;
 
 @Data
 public class CategoryRequestDto implements Entity {
+    // 分类id
     private Integer id;
+    // 层级
     private Integer level;
+    // 当前页
     private Integer page;
+    // 页面大小
     private Integer size;
+    // 名称
     private String name;
+    // 上级id
     private Integer pid;
+    // 上级id列表
     private List<Integer> pidList;
 }

ch-wx-api/src/main/java/com/wwdz/ch/wx/entity/request/FootPrintRequestDto.java

@@ -7,11 +7,17 @@ import java.util.List;
 
 @Data
 public class FootPrintRequestDto implements Entity {
+    // id
     private Long id;
+    // 用户id
     private Long userId;
+    // 藏品id
     private Long itemId;
     private Integer when;
+    // 当前页
     private Integer page;
+    // 页面大小
     private Integer size;
+    // id列表
     private List<Long> ids;
 }

ch-wx-api/src/main/java/com/wwdz/ch/wx/entity/request/KlDataRequestDto.java

-package com.wwdz.ch.wx.entity.request;
-
-import com.xxdxxs.entity.Entity;
-import lombok.Data;
-
-@Data
-public class KlDataRequestDto implements Entity {
-    private String kl_data;
-}

ch-wx-api/src/main/java/com/wwdz/ch/wx/entity/request/UserRequestDto.java

@@ -5,25 +5,44 @@ import lombok.Data;
 
 @Data
 public class UserRequestDto implements Entity {
+    // 用户id
     private Long userId;
+    // 手机号
     private String mobile;
+    // 获取手机号授权码
     private String code;
+    // 登录后授权码
     private String loginCode;
+    // 验证码
     private String smsCode;
+    // 头像
     private String avatarUrl;
+    // 邀请人id
     private Long shareUserId;
+    // 昵称
     private String nickname;
+    // 微信id
     private String wechatId;
+    // 修改前手机号
     private String beforeMobile;
+    // 修改后手机号
     private String afterMobile;
+    // 个性签名
     private String profile;
+    // 背景图片
     private String background;
+    // 验证码类型login登录update修改手机号
     private String smsType;
+    // 加密字符串
     private String encryptedData;
+    // 解密用
     private String iv;
+    // 微信登录版本类型1新版本2旧版本
     private Integer type;
     // 快捷登录方式（1、微信，2、支付宝，3、抖音）
     private Integer loginType;
+    // 微信openid
     private String wxOpenId;
+    // 支付宝user_id
     private String alipayUserId;
 }

ch-wx-api/src/main/java/com/wwdz/ch/wx/entity/vo/AgentTranceResponseVo.java

@@ -3,9 +3,15 @@ package com.wwdz.ch.wx.entity.vo;
 import com.xxdxxs.entity.Entity;
 import lombok.Data;
 
+/**
+ * 前端用列表响应对象
+ */
 @Data
 public class AgentTranceResponseVo implements Entity {
+    // 前端用，目前固定值""
     private String agentTraceInfo_;
+    // 前端用展示列表的布局类型1藏品瀑布流2收藏册
     private Integer viewType;
+    // 前端用最终返回对象，需要用后端对象赋值
     private Object detail;
 }

ch-wx-api/src/main/java/com/wwdz/ch/wx/entity/vo/CategoryResponseVo.java

@@ -5,11 +5,19 @@ import lombok.Data;
 
 import java.util.List;
 
+/**
+ * 分类响应对象
+ */
 @Data
 public class CategoryResponseVo implements Entity {
+    // 分类id
     private Integer cid;
+    // 上级id
     private Integer pid;
+    // 分类名称
     private String categoryName;
+    // 下级列表
     private List<CategoryResponseVo> child;
+    // 是否选中1是0否
     private Integer isChosen;
 }

ch-wx-api/src/main/java/com/wwdz/ch/wx/entity/vo/FavoritesResponseVo.java

@@ -6,16 +6,29 @@ import lombok.Data;
 import java.util.Date;
 import java.util.List;
 
+/**
+ * 收藏册响应对象
+ */
 @Data
 public class FavoritesResponseVo implements Entity {
+    // 收藏册id
     private Long id;
+    // 标题
     private String title;
+    // 描述
     private String description;
+    // 排序
     private Integer sort;
+    // 创建时间
     private Date addTime;
+    // 更新时间
     private Date updateTime;
+    // 是否删除true已删除
     private Boolean deleted;
+    // 封面图片
     private List<String> images;
+    // 收藏数
     private long count;
+    // 是否客态true是
     private Boolean isGuest;
 }

ch-wx-api/src/main/java/com/wwdz/ch/wx/entity/vo/FollowFansRecordVo.java

-package com.wwdz.ch.wx.entity.vo;
-
-import com.xxdxxs.entity.Entity;
-import lombok.Data;
-
-import java.util.Date;
-
-@Data
-public class FollowFansRecordVo implements Entity {
-
-    private Integer id;
-
-    /**
-     * 粉丝id
-     */
-    private Long fansId;
-
-    private String fansName;
-
-    /**
-     * 粉丝头像
-     */
-    private String fansIcon;
-
-    /**
-     * 粉丝个人简介
-     */
-    private String fansProfile;
-
-    /**
-     * 被关注者id
-     */
-    private Long followerId;
-
-    private String followerName;
-
-    /**
-     * 关注人头像
-     */
-    private String followerIcon;
-
-    /**
-     * 关注的人个人简介
-     */
-    private String followerProfile;
-
-    /**
-     * 关系（已关注，互相关注，未关注）
-     */
-    private String relation;
-
-    /**
-     * 关系（已关注，互相关注，未关注）
-     */
-    private Integer relationCode;
-
-    /**
-     * 创建时间
-     */
-    private Date createTime;
-
-    /**
-     * 更新时间
-     */
-    private Date updateTime;
-
-    /**
-     * 状态
-     */
-    private Integer state;
-
-    private String stateName;
-
-}

ch-wx-api/src/main/java/com/wwdz/ch/wx/entity/vo/FootPrintResponseVo.java

@@ -5,8 +5,12 @@ import lombok.Data;
 
 import java.util.List;
 
+/**
+ * 足迹响应对象
+ */
 @Data
 public class FootPrintResponseVo implements Entity {
+    // 日期类型1今天2昨天3一周内4一月内
     private Integer timeType;
     private List<ItemResponseVo> items;
 }

ch-wx-api/src/main/java/com/wwdz/ch/wx/entity/vo/ItemResponseVo.java

@@ -6,35 +6,65 @@ import lombok.Data;
 import java.util.List;
 import java.util.Map;
 
+/**
+ * 藏品响应对象
+ */
 @Data
 public class ItemResponseVo implements Entity {
+    // 藏品id
     private Long id;
+    // 藏品id
     private Long itemId;
+    // 分类id
     private Integer cid;
+    // 分类名称
     private String categoryName;
+    // 名称
     private String name;
+    // 图片
     private String images;
+    // 价格
     private String price;
+    // 详细信息
     private String detail;
+    // 来源1系统2用户
     private Integer sourceType;
+    // 是否已收藏1是0否
     private Integer isCollected;
+    // 收藏册id
     private Long favoritesId;
+    // 收藏数
     private String collectCount;
+    // 是否是自己发布的1是0否
     private Integer isMine;
+    // 创建时间
     private String createTime;
+    // 视频
     private String videos;
+    // 用于列表展示的图片对象
     private Map<String, Object> homePageImage;
+    // 是否已删除1是0否
     private Boolean isDeleted;
+    // 藏品发布者的头像
     private String itemAvatar;
+    // 藏品发布者的名称
     private String itemNickname;
+    // 藏品发布者的用户id
     private Long itemUserId;
+    // 藏品发布者的个性签名
     private String profile;
+    // 用于足迹用的日期类型1今天2昨天3一周内4一月内
     private Integer timeType;
     private List<Map<String, Object>> imagesList;
     private List<Map<String, Object>> videosList;
+    // 权限0公有1私有
     private Integer viewPermission;
+    // 是否已关注1是0否
     private Boolean isFollowed;
+    // 关注记录的id
     private Integer followedId;
+    // 浏览量
     private String viewsNumber;
+    // 1展示浏览量2展示"仅自己可见"标签
     private Integer isDisplay;
 }

ch-wx-api/src/main/java/com/wwdz/ch/wx/impl/FavoritesServiceImpl.java

@@ -30,6 +30,9 @@ import javax.servlet.http.HttpServletRequest;
 import java.util.*;
 import java.util.stream.Collectors;
 
+/**
+ * 收藏册服务类
+ */
 @Service
 public class FavoritesServiceImpl implements FavoritesService {
     private static final Logger logger = LoggerFactory.getLogger(FavoritesServiceImpl.class);

ch-wx-api/src/main/java/com/wwdz/ch/wx/impl/FootPrintServiceImpl.java

@@ -28,6 +28,9 @@ import java.text.SimpleDateFormat;
 import java.util.*;
 import java.util.stream.Collectors;
 
+/**
+ * 足迹服务类
+ */
 @Service
 public class FootPrintServiceImpl implements FootPrintService {
     private static final Logger logger = LoggerFactory.getLogger(FootPrintServiceImpl.class);

ch-wx-api/src/main/java/com/wwdz/ch/wx/impl/ItemCommonServiceImpl.java

@@ -22,6 +22,9 @@ import java.util.Map;
 import java.util.Objects;
 import java.util.stream.Collectors;
 
+/**
+ * 一些公用服务类
+ */
 @Service
 public class ItemCommonServiceImpl implements ItemCommonService {
     @Autowired

ch-wx-api/src/main/java/com/wwdz/ch/wx/impl/ItemServiceImpl.java

@@ -55,6 +55,9 @@ import java.time.LocalDateTime;
 import java.util.*;
 import java.util.stream.Collectors;
 
+/**
+ * 藏品服务类
+ */
 @Service
 public class ItemServiceImpl implements ItemService {
     private static final Logger logger = LoggerFactory.getLogger(ItemServiceImpl.class);

ch-wx-api/src/main/java/com/wwdz/ch/wx/impl/KeywordServiceImpl.java

@@ -14,6 +14,9 @@ import java.util.ArrayList;
 import java.util.List;
 import java.util.stream.Collectors;
 
+/**
+ * 推荐词服务类
+ */
 @Service
 public class KeywordServiceImpl implements KeywordService {
     private static final Logger logger = LoggerFactory.getLogger(KeywordServiceImpl.class);

ch-wx-api/src/main/java/com/wwdz/ch/wx/impl/SwitchServiceImpl.java

@@ -6,6 +6,9 @@ import com.wwdz.ch.wx.service.SwitchService;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
 
+/**
+ * 开关服务类
+ */
 @Service
 public class SwitchServiceImpl implements SwitchService {
     @Autowired

ch-wx-api/src/main/java/com/wwdz/ch/wx/impl/UserServiceImpl.java

@@ -47,6 +47,9 @@ import java.util.HashMap;
 import java.util.Map;
 import java.util.Objects;
 
+/**
+ * 用户服务类
+ */
 @Service
 public class UserServiceImpl implements UserService {
     private static final Logger logger = LoggerFactory.getLogger(UserServiceImpl.class);

ch-wx-api/src/main/java/com/wwdz/ch/wx/interceptor/LoginInterceptor.java

@@ -21,6 +21,9 @@ import java.util.HashMap;
 import java.util.Map;
 import java.util.Objects;
 
+/**
+ * 拦截器
+ */
 public class LoginInterceptor implements HandlerInterceptor {
     Logger logger = LoggerFactory.getLogger(LoginInterceptor.class);
 
@@ -42,6 +45,7 @@ public class LoginInterceptor implements HandlerInterceptor {
     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
         logger.info("进入拦截器");
         String token = request.getHeader("Authorization");
+        // 判断开关状态
         Switch switchh = switchService.findOnly();
         boolean isOpen = Objects.nonNull(switchh) && switchh.getState() == 1;
         logger.info("isOpen:" + isOpen);
@@ -65,6 +69,7 @@ public class LoginInterceptor implements HandlerInterceptor {
             response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
             response.getWriter().write(JSON.toJSONString(map));
         } else {
+            // 拦截类型1放行2未登录3未授权
             int loginType = 1;
             if (StringUtils.isBlank(token)) {
                 loginType = 2;

ch-wx-api/src/main/java/com/wwdz/ch/wx/service/FavoritesService.java

@@ -41,7 +41,7 @@ public interface FavoritesService {
     Result update(FavoritesRequestDto dto);
 
     /**
-     * 收藏册基本详情
+     * 收藏册基本详情（支持后期未登录用户查看）
      *
      * @param dto
      * @return
@@ -57,7 +57,7 @@ public interface FavoritesService {
     Result favoritesNum(FavoritesRequestDto dto);
 
     /**
-     * 收藏册下藏品列表
+     * 收藏册下藏品列表（支持后期未登录用户查看）
      *
      * @param dto
      * @return

ch-wx-api/src/main/java/com/wwdz/ch/wx/service/ItemService.java

@@ -16,7 +16,7 @@ public interface ItemService {
     Result nameList(ItemRequestDto dto);
 
     /**
-     * 首页
+     * 首页（支持后期未登录用户查看）
      *
      * @param dto
      * @return
@@ -48,7 +48,7 @@ public interface ItemService {
     Result add(ItemRequestDto dto);
 
     /**
-     * 藏品详情
+     * 藏品详情（支持后期未登录用户查看）
      *
      * @param dto
      * @return

ch-wx-api/src/main/java/com/wwdz/ch/wx/util/StringUtil.java

@@ -2,6 +2,9 @@ package com.wwdz.ch.wx.util;
 
 import java.util.Random;
 
+/**
+ * String处理工具类
+ */
 public class StringUtil {
     private static final String ALLOWED_CHARACTERS = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
 

ch-wx-api/src/main/java/com/wwdz/ch/wx/web/WxCategoryController.java

@@ -16,6 +16,9 @@ import org.springframework.web.bind.annotation.RestController;
 
 import java.util.Objects;
 
+/**
+ * 分类控制器
+ */
 @RestController
 @RequestMapping("/wx/category")
 public class WxCategoryController {

ch-wx-api/src/main/java/com/wwdz/ch/wx/web/WxCollectController.java

 package com.wwdz.ch.wx.web;
 
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-
-import javax.validation.constraints.NotNull;
-
+import com.alibaba.fastjson.JSONObject;
+import com.wwdz.ch.core.util.JacksonUtil;
+import com.wwdz.ch.core.util.ResponseUtil;
 import com.wwdz.ch.db.dao.ItemDao;
 import com.wwdz.ch.db.dao.dts.DtsCollectDao;
+import com.wwdz.ch.db.domain.CollectObsolete;
 import com.wwdz.ch.db.domain.Item;
 import com.wwdz.ch.wx.annotation.LoginUser;
 import org.apache.commons.lang3.ObjectUtils;
@@ -16,20 +13,16 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.validation.annotation.Validated;
-import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.PostMapping;
-import org.springframework.web.bind.annotation.RequestBody;
-import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RequestParam;
-import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.bind.annotation.*;
 
-import com.alibaba.fastjson.JSONObject;
-import com.wwdz.ch.core.util.JacksonUtil;
-import com.wwdz.ch.core.util.ResponseUtil;
-import com.wwdz.ch.db.domain.CollectObsolete;
+import javax.validation.constraints.NotNull;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
 
 /**
- * 用户收藏服务
+ * 用户收藏服务（暂未用）
  */
 @RestController
 @RequestMapping("/wx/collect")

ch-wx-api/src/main/java/com/wwdz/ch/wx/web/WxFavoritesController.java

@@ -19,6 +19,9 @@ import org.springframework.web.bind.annotation.RestController;
 import javax.servlet.http.HttpServletRequest;
 import java.util.Objects;
 
+/**
+ * 收藏册控制器
+ */
 @RestController
 @RequestMapping("/wx/favorites")
 public class WxFavoritesController {

ch-wx-api/src/main/java/com/wwdz/ch/wx/web/WxFeedbackController.java

@@ -20,7 +20,7 @@ import com.wwdz.ch.db.domain.Feedback;
 import com.wwdz.ch.db.domain.User;
 
 /**
- * 意见反馈服务
+ * 意见反馈服务（暂未用）
  *
  * @author CHENBO
  * @since 1.0.0

ch-wx-api/src/main/java/com/wwdz/ch/wx/web/WxFootprintController.java

@@ -17,7 +17,7 @@ import org.springframework.web.bind.annotation.RestController;
 import java.util.Objects;
 
 /**
- * 用户访问足迹服务
+ * 足迹控制器
  */
 @RestController
 @RequestMapping("/wx/footprint")

ch-wx-api/src/main/java/com/wwdz/ch/wx/web/WxGoodsController.java

@@ -37,7 +37,7 @@ import java.util.concurrent.ThreadPoolExecutor;
 import java.util.concurrent.TimeUnit;
 
 /**
- * 商品服务
+ * 商品服务（暂未用）
  */
 @RestController
 @RequestMapping("/wx/goods")

ch-wx-api/src/main/java/com/wwdz/ch/wx/web/WxHomeController.java

@@ -22,7 +22,7 @@ import java.util.Map;
 import java.util.concurrent.*;
 
 /**
- * 首页服务
+ * 首页服务（暂未用）
  */
 @RestController
 @RequestMapping("/wx/home")

ch-wx-api/src/main/java/com/wwdz/ch/wx/web/WxItemController.java

@@ -16,6 +16,9 @@ import javax.servlet.http.HttpServletRequest;
 import java.util.ArrayList;
 import java.util.Objects;
 
+/**
+ * 藏品控制器
+ */
 @RestController
 @RequestMapping("/wx/item")
 public class WxItemController {

ch-wx-api/src/main/java/com/wwdz/ch/wx/web/WxKeywordController.java

@@ -10,6 +10,9 @@ import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
+/**
+ * 推荐词控制器
+ */
 @RestController
 @RequestMapping("/wx/keyword")
 public class WxKeywordController {

ch-wx-api/src/main/java/com/wwdz/ch/wx/web/WxSearchController.java

@@ -26,7 +26,7 @@ import com.wwdz.ch.db.domain.Keyword;
 import com.wwdz.ch.db.domain.SearchHistory;
 
 /**
- * 商品搜索服务
+ * 商品搜索服务（暂未用）
  * <p>
  * 注意：目前搜索功能非常简单，只是基于关键字匹配。
  */

ch-wx-api/src/main/java/com/wwdz/ch/wx/web/WxStorageController.java

 package com.wwdz.ch.wx.web;
 
-import java.io.IOException;
-import java.io.InputStream;
-import java.util.*;
-import java.util.concurrent.CountDownLatch;
-import java.util.concurrent.ExecutorService;
-import java.util.concurrent.Executors;
-
+import com.alibaba.fastjson.JSONObject;
+import com.wwdz.ch.core.storage.StorageService;
+import com.wwdz.ch.core.util.CharUtil;
+import com.wwdz.ch.core.util.ResponseUtil;
 import com.wwdz.ch.db.dao.dts.DtsStorageDao;
+import com.wwdz.ch.db.domain.Storage;
 import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import org.slf4j.Logger;
@@ -18,22 +16,18 @@ import org.springframework.http.HttpHeaders;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
 import org.springframework.validation.annotation.Validated;
-import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.PathVariable;
-import org.springframework.web.bind.annotation.PostMapping;
-import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RequestParam;
-import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.bind.annotation.*;
 import org.springframework.web.multipart.MultipartFile;
 
-import com.alibaba.fastjson.JSONObject;
-import com.wwdz.ch.core.storage.StorageService;
-import com.wwdz.ch.core.util.CharUtil;
-import com.wwdz.ch.core.util.ResponseUtil;
-import com.wwdz.ch.db.domain.Storage;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.*;
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
 
 /**
- * 对象存储服务
+ * 对象存储服务（暂未用）
  */
 @RestController
 @RequestMapping("/wx/storage")

ch-wx-api/src/main/java/com/wwdz/ch/wx/web/WxUserFormId.java

 package com.wwdz.ch.wx.web;
 
-import java.time.LocalDateTime;
-
-import javax.validation.constraints.NotNull;
-
+import com.alibaba.fastjson.JSONObject;
+import com.wwdz.ch.core.util.ResponseUtil;
 import com.wwdz.ch.db.dao.dts.DtsUserDao;
 import com.wwdz.ch.db.dao.dts.DtsUserFormIdDao;
+import com.wwdz.ch.db.domain.User;
+import com.wwdz.ch.db.domain.UserFormidObsolete;
 import com.wwdz.ch.wx.annotation.LoginUser;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -15,11 +15,12 @@ import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
-import com.alibaba.fastjson.JSONObject;
-import com.wwdz.ch.core.util.ResponseUtil;
-import com.wwdz.ch.db.domain.User;
-import com.wwdz.ch.db.domain.UserFormidObsolete;
+import javax.validation.constraints.NotNull;
+import java.time.LocalDateTime;
 
+/**
+ * 暂未用
+ */
 @RestController
 @RequestMapping("/wx/formid")
 @Validated