dsc2

SuperRice/springboot/src/main/java/com/example/common/Result.java

@@ -2,18 +2,43 @@ package com.example.common;
 
 import com.example.common.enums.ResultCodeEnum;
 
+/**
+ * 通用返回结果类，用于封装接口返回的数据
+ */
 public class Result {
+    /**
+     * 状态码
+     */
     private String code;
+    /**
+     * 消息
+     */
     private String msg;
+    /**
+     * 数据
+     */
     private Object data;
 
+    /**
+     * 带数据的构造函数
+     *
+     * @param data 返回的数据
+     */
     private Result(Object data) {
         this.data = data;
     }
 
+    /**
+     * 无参构造函数
+     */
     public Result() {
     }
 
+    /**
+     * 创建成功的返回结果，不带数据
+     *
+     * @return 成功的返回结果对象
+     */
     public static Result success() {
         Result tResult = new Result();
         tResult.setCode(ResultCodeEnum.SUCCESS.code);
@@ -21,13 +46,24 @@ public class Result {
         return tResult;
     }
 
+    /**
+     * 创建成功的返回结果，带数据
+     *
+     * @param data 成功时返回的数据
+     * @return 成功的返回结果对象
+     */
     public static Result success(Object data) {
-        Result tResult = new Result (data);
+        Result tResult = new Result(data);
         tResult.setCode(ResultCodeEnum.SUCCESS.code);
         tResult.setMsg(ResultCodeEnum.SUCCESS.msg);
         return tResult;
     }
 
+    /**
+     * 创建错误的返回结果，不带状态码和消息
+     *
+     * @return 错误的返回结果对象
+     */
     public static Result error() {
         Result tResult = new Result();
         tResult.setCode(ResultCodeEnum.SYSTEM_ERROR.code);
@@ -35,6 +71,13 @@ public class Result {
         return tResult;
     }
 
+    /**
+     * 创建错误的返回结果，带自定义状态码和消息
+     *
+     * @param code 状态码
+     * @param msg  消息
+     * @return 错误的返回结果对象
+     */
     public static Result error(String code, String msg) {
         Result tResult = new Result();
         tResult.setCode(code);
@@ -42,6 +85,12 @@ public class Result {
         return tResult;
     }
 
+    /**
+     * 创建错误的返回结果，带枚举类型的状态码和消息
+     *
+     * @param resultCodeEnum 枚举类型的状态码和消息
+     * @return 错误的返回结果对象
+     */
     public static Result error(ResultCodeEnum resultCodeEnum) {
         Result tResult = new Result();
         tResult.setCode(resultCodeEnum.code);
@@ -49,26 +98,56 @@ public class Result {
         return tResult;
     }
 
+    /**
+     * 获取状态码
+     *
+     * @return 状态码
+     */
     public String getCode() {
         return code;
     }
 
+    /**
+     * 设置状态码
+     *
+     * @param code 状态码
+     */
     public void setCode(String code) {
         this.code = code;
     }
 
+    /**
+     * 获取消息
+     *
+     * @return 消息
+     */
     public String getMsg() {
         return msg;
     }
 
+    /**
+     * 设置消息
+     *
+     * @param msg 消息
+     */
     public void setMsg(String msg) {
         this.msg = msg;
     }
 
+    /**
+     * 获取数据
+     *
+     * @return 数据
+     */
     public Object getData() {
         return data;
     }
 
+    /**
+     * 设置数据
+     *
+     * @param data 数据
+     */
     public void setData(Object data) {
         this.data = data;
     }

SuperRice/springboot/src/main/java/com/example/common/config/CorsConfig.java

@@ -7,19 +7,34 @@ import org.springframework.web.cors.UrlBasedCorsConfigurationSource;
 import org.springframework.web.filter.CorsFilter;
 
 /**
- * 跨域配置
+ * 跨域配置类，用于解决跨域请求问题
  */
 @Configuration
 public class CorsConfig {
 
+    /**
+     * 创建并配置跨域过滤器
+     *
+     * 该方法通过定义跨域配置，指定允许跨域请求的源、请求头和请求方法，
+     * 并将这些配置应用到所有路径，以解决前端跨域请求后端接口的问题
+     *
+     * @return CorsFilter 跨域过滤器实例
+     */
     @Bean
     public CorsFilter corsFilter() {
+        // 创建URL基于的跨域配置源
         UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
+        // 创建跨域配置对象
         CorsConfiguration corsConfiguration = new CorsConfiguration();
+        // 设置允许任何源进行跨域请求
         corsConfiguration.addAllowedOrigin("*"); // 1 设置访问源地址
+        // 设置允许任何请求头进行跨域请求
         corsConfiguration.addAllowedHeader("*"); // 2 设置访问源请求头
+        // 设置允许任何请求方法进行跨域请求
         corsConfiguration.addAllowedMethod("*"); // 3 设置访问源请求方法
+        // 将跨域配置应用到所有路径
         source.registerCorsConfiguration("/**", corsConfiguration); // 4 对接口配置跨域设置
+        // 返回跨域过滤器实例
         return new CorsFilter(source);
     }
-}
+}

SuperRice/springboot/src/main/java/com/example/common/config/JwtInterceptor.java

@@ -36,6 +36,16 @@ public class JwtInterceptor implements HandlerInterceptor {
     private BusinessService businessService;
     @Resource
     private UserService userService;
+
+    /**
+     * 在请求处理之前进行拦截
+     *
+     * @param request  请求对象
+     * @param response 响应对象
+     * @param handler  处理请求的对象
+     * @return 是否继续执行其他拦截器和请求本身
+     * @throws Exception 可能抛出的异常
+     */
     @Override
     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
         // 1. 从http请求的header中获取token
@@ -46,6 +56,7 @@ public class JwtInterceptor implements HandlerInterceptor {
         }
         // 2. 开始执行认证
         if (ObjectUtil.isEmpty(token)) {
+            // 如果仍然没有拿到token，抛出异常，提示token无效
             throw new CustomException(ResultCodeEnum.TOKEN_INVALID_ERROR);
         }
         Account account = null;
@@ -65,9 +76,11 @@ public class JwtInterceptor implements HandlerInterceptor {
                 account = userService.selectById(Integer.valueOf(userId));
             }
         } catch (Exception e) {
+            // 如果解析token或者查询用户信息出错，抛出异常，提示token验证失败
             throw new CustomException(ResultCodeEnum.TOKEN_CHECK_ERROR);
         }
         if (ObjectUtil.isNull(account)) {
+            // 如果用户信息为空，抛出异常，提示用户不存在
             throw new CustomException(ResultCodeEnum.USER_NOT_EXIST_ERROR);
         }
         try {
@@ -75,8 +88,9 @@ public class JwtInterceptor implements HandlerInterceptor {
             JWTVerifier jwtVerifier = JWT.require(Algorithm.HMAC256(account.getPassword())).build();
             jwtVerifier.verify(token); // 验证token
         } catch (JWTVerificationException e) {
+            // 如果token验证失败，抛出异常，提示token验证失败
             throw new CustomException(ResultCodeEnum.TOKEN_CHECK_ERROR);
         }
         return true;
     }
-}
+}

SuperRice/springboot/src/main/java/com/example/common/config/WebConfig.java

@@ -6,19 +6,29 @@ import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 
 import javax.annotation.Resource;
 
+/**
+ * Web配置类，用于注册自定义拦截器
+ */
 @Configuration
 public class WebConfig implements  WebMvcConfigurer {
 
+    // 注入JwtInterceptor拦截器
     @Resource
     private JwtInterceptor jwtInterceptor;
 
+    /**
+     * 添加拦截器配置
+     *
+     * @param registry 拦截器注册对象，用于管理拦截器的路径和排除规则
+     */
     // 加自定义拦截器JwtInterceptor，设置拦截规则
     @Override
     public void addInterceptors(InterceptorRegistry registry) {
+        // 设置JwtInterceptor拦截所有路径，但排除根路径、登录、注册和文件相关路径
         registry.addInterceptor(jwtInterceptor).addPathPatterns("/**")
                 .excludePathPatterns("/")
                 .excludePathPatterns("/login")
                 .excludePathPatterns("/register")
                 .excludePathPatterns("/files/**");
     }
-}
+}

SuperRice/springboot/src/main/java/com/example/common/enums/ResultCodeEnum.java

@@ -1,25 +1,43 @@
 package com.example.common.enums;
 
+/**
+ * 结果代码枚举类，用于定义系统中各种操作结果的代码和消息
+ */
 public enum ResultCodeEnum {
+    // 成功状态
     SUCCESS("200", "成功"),
 
+    // 参数错误相关状态
     PARAM_ERROR("400", "参数异常"),
+    // Token 相关错误状态
     TOKEN_INVALID_ERROR("401", "无效的token"),
     TOKEN_CHECK_ERROR("401", "token验证失败，请重新登录"),
+    // 参数缺失错误状态
     PARAM_LOST_ERROR("4001", "参数缺失"),
 
+    // 系统错误相关状态
     SYSTEM_ERROR("500", "系统异常"),
+    // 用户相关错误状态
     USER_EXIST_ERROR("5001", "用户名已存在"),
     USER_NOT_LOGIN("5002", "用户未登录"),
     USER_ACCOUNT_ERROR("5003", "账号或密码错误"),
     USER_NOT_EXIST_ERROR("5004", "用户不存在"),
     PARAM_PASSWORD_ERROR("5005", "原密码输入错误"),
+    // 业务逻辑相关错误状态
     COLLECT_ALREADY_ERROR("5006", "您已收藏过该商品，请勿重复收藏"),
     ;
 
+    // 状态码
     public String code;
+    // 状态消息
     public String msg;
 
+    /**
+     * 构造函数，初始化状态码和消息
+     *
+     * @param code 状态码
+     * @param msg  状态消息
+     */
     ResultCodeEnum(String code, String msg) {
         this.code = code;
         this.msg = msg;

SuperRice/springboot/src/main/java/com/example/controller/AddressController.java

@@ -20,7 +20,9 @@ public class AddressController {
     private AddressService addressService;
 
     /**
-     * 新增
+     * 新增地址信息
+     * @param address 待添加的地址对象
+     * @return 操作结果
      */
     @PostMapping("/add")
     public Result add(@RequestBody Address address) {
@@ -29,7 +31,9 @@ public class AddressController {
     }
 
     /**
-     * 删除
+     * 根据ID删除地址信息
+     * @param id 待删除的地址ID
+     * @return 操作结果
      */
     @DeleteMapping("/delete/{id}")
     public Result deleteById(@PathVariable Integer id) {
@@ -38,7 +42,9 @@ public class AddressController {
     }
 
     /**
-     * 批量删除
+     * 批量删除地址信息
+     * @param ids 待删除的地址ID列表
+     * @return 操作结果
      */
     @DeleteMapping("/delete/batch")
     public Result deleteBatch(@RequestBody List<Integer> ids) {
@@ -47,7 +53,9 @@ public class AddressController {
     }
 
     /**
-     * 修改
+     * 修改地址信息
+     * @param address 待修改的地址对象
+     * @return 操作结果
      */
     @PutMapping("/update")
     public Result updateById(@RequestBody Address address) {
@@ -56,7 +64,9 @@ public class AddressController {
     }
 
     /**
-     * 根据ID查询
+     * 根据ID查询地址信息
+     * @param id 待查询的地址ID
+     * @return 地址对象
      */
     @GetMapping("/selectById/{id}")
     public Result selectById(@PathVariable Integer id) {
@@ -65,7 +75,9 @@ public class AddressController {
     }
 
     /**
-     * 查询所有
+     * 查询所有地址信息
+     * @param address 地址对象，用于传递查询条件
+     * @return 地址列表
      */
     @GetMapping("/selectAll")
     public Result selectAll(Address address ) {
@@ -74,7 +86,11 @@ public class AddressController {
     }
 
     /**
-     * 分页查询
+     * 分页查询地址信息
+     * @param address 地址对象，用于传递查询条件
+     * @param pageNum 当前页码
+     * @param pageSize 每页大小
+     * @return 分页信息
      */
     @GetMapping("/selectPage")
     public Result selectPage(Address address,
@@ -84,4 +100,4 @@ public class AddressController {
         return Result.success(page);
     }
 
-}
+}

SuperRice/springboot/src/main/java/com/example/controller/AdminController.java

@@ -19,7 +19,9 @@ public class AdminController {
     private AdminService adminService;
 
     /**
-     * 新增
+     * 新增管理员信息
+     * @param admin 管理员对象，包含要新增的信息
+     * @return 返回结果对象，表示操作是否成功
      */
     @PostMapping("/add")
     public Result add(@RequestBody Admin admin) {
@@ -28,7 +30,9 @@ public class AdminController {
     }
 
     /**
-     * 删除
+     * 根据ID删除管理员信息
+     * @param id 管理员ID
+     * @return 返回结果对象，表示操作是否成功
      */
     @DeleteMapping("/delete/{id}")
     public Result deleteById(@PathVariable Integer id) {
@@ -37,7 +41,9 @@ public class AdminController {
     }
 
     /**
-     * 批量删除
+     * 批量删除管理员信息
+     * @param ids 管理员ID列表，用于指定要删除的记录
+     * @return 返回结果对象，表示操作是否成功
      */
     @DeleteMapping("/delete/batch")
     public Result deleteBatch(@RequestBody List<Integer> ids) {
@@ -46,7 +52,9 @@ public class AdminController {
     }
 
     /**
-     * 修改
+     * 修改管理员信息
+     * @param admin 管理员对象，包含要修改的信息
+     * @return 返回结果对象，表示操作是否成功
      */
     @PutMapping("/update")
     public Result updateById(@RequestBody Admin admin) {
@@ -55,7 +63,9 @@ public class AdminController {
     }
 
     /**
-     * 根据ID查询
+     * 根据ID查询管理员信息
+     * @param id 管理员ID
+     * @return 返回结果对象，包含查询到的管理员信息
      */
     @GetMapping("/selectById/{id}")
     public Result selectById(@PathVariable Integer id) {
@@ -64,7 +74,9 @@ public class AdminController {
     }
 
     /**
-     * 查询所有
+     * 查询所有管理员信息
+     * @param admin 管理员对象，用于指定查询条件
+     * @return 返回结果对象，包含查询到的管理员信息列表
      */
     @GetMapping("/selectAll")
     public Result selectAll(Admin admin ) {
@@ -73,7 +85,11 @@ public class AdminController {
     }
 
     /**
-     * 分页查询
+     * 分页查询管理员信息
+     * @param admin 管理员对象，用于指定查询条件
+     * @param pageNum 页码，用于指定当前页
+     * @param pageSize 每页大小，用于指定每页记录数
+     * @return 返回结果对象，包含查询到的分页管理员信息
      */
     @GetMapping("/selectPage")
     public Result selectPage(Admin admin,
@@ -83,4 +99,4 @@ public class AdminController {
         return Result.success(page);
     }
 
-}
+}

SuperRice/springboot/src/main/java/com/example/controller/BusinessController.java

@@ -1,9 +1,7 @@
 package com.example.controller;
 
 import com.example.common.Result;
-import com.example.entity.Admin;
 import com.example.entity.Business;
-import com.example.service.AdminService;
 import com.example.service.BusinessService;
 import com.github.pagehelper.PageInfo;
 import org.springframework.web.bind.annotation.*;
@@ -22,7 +20,9 @@ public class BusinessController {
     private BusinessService businessService;
 
     /**
-     * 新增
+     * 新增商家信息
+     * @param business 商家对象，包含要新增的商家信息
+     * @return 返回结果对象，表示新增操作是否成功
      */
     @PostMapping("/add")
     public Result add(@RequestBody Business business) {
@@ -31,7 +31,9 @@ public class BusinessController {
     }
 
     /**
-     * 删除
+     * 根据ID删除商家信息
+     * @param id 商家ID，用于标识要删除的商家
+     * @return 返回结果对象，表示删除操作是否成功
      */
     @DeleteMapping("/delete/{id}")
     public Result deleteById(@PathVariable Integer id) {
@@ -40,7 +42,9 @@ public class BusinessController {
     }
 
     /**
-     * 批量删除
+     * 批量删除商家信息
+     * @param ids 商家ID列表，用于标识要批量删除的商家
+     * @return 返回结果对象，表示批量删除操作是否成功
      */
     @DeleteMapping("/delete/batch")
     public Result deleteBatch(@RequestBody List<Integer> ids) {
@@ -49,7 +53,9 @@ public class BusinessController {
     }
 
     /**
-     * 修改
+     * 修改商家信息
+     * @param business 商家对象，包含要修改的商家信息
+     * @return 返回结果对象，表示修改操作是否成功
      */
     @PutMapping("/update")
     public Result updateById(@RequestBody Business business) {
@@ -58,7 +64,9 @@ public class BusinessController {
     }
 
     /**
-     * 根据ID查询
+     * 根据ID查询商家信息
+     * @param id 商家ID，用于标识要查询的商家
+     * @return 返回结果对象，包含查询到的商家信息
      */
     @GetMapping("/selectById/{id}")
     public Result selectById(@PathVariable Integer id) {
@@ -67,7 +75,9 @@ public class BusinessController {
     }
 
     /**
-     * 查询所有
+     * 查询所有商家信息
+     * @param business 商家对象，用于指定查询条件
+     * @return 返回结果对象，包含所有查询到的商家信息列表
      */
     @GetMapping("/selectAll")
     public Result selectAll(Business business ) {
@@ -76,7 +86,11 @@ public class BusinessController {
     }
 
     /**
-     * 分页查询
+     * 分页查询商家信息
+     * @param business 商家对象，用于指定查询条件
+     * @param pageNum 页码，用于指定当前页
+     * @param pageSize 每页大小，用于指定每页显示的记录数
+     * @return 返回结果对象，包含分页查询到的商家信息
      */
     @GetMapping("/selectPage")
     public Result selectPage(Business business,
@@ -86,4 +100,4 @@ public class BusinessController {
         return Result.success(page);
     }
 
-}
+}

SuperRice/springboot/src/main/java/com/example/controller/CartController.java

@@ -20,7 +20,9 @@ public class CartController {
     private CartService cartService;
 
     /**
-     * 新增
+     * 新增购物车项
+     * @param cart 购物车项信息
+     * @return 操作结果
      */
     @PostMapping("/add")
     public Result add(@RequestBody Cart cart) {
@@ -29,7 +31,9 @@ public class CartController {
     }
 
     /**
-     * 删除
+     * 根据ID删除购物车项
+     * @param id 购物车项ID
+     * @return 操作结果
      */
     @DeleteMapping("/delete/{id}")
     public Result deleteById(@PathVariable Integer id) {
@@ -38,7 +42,9 @@ public class CartController {
     }
 
     /**
-     * 批量删除
+     * 批量删除购物车项
+     * @param ids 购物车项ID列表
+     * @return 操作结果
      */
     @DeleteMapping("/delete/batch")
     public Result deleteBatch(@RequestBody List<Integer> ids) {
@@ -47,7 +53,9 @@ public class CartController {
     }
 
     /**
-     * 修改
+     * 修改购物车项信息
+     * @param cart 购物车项信息
+     * @return 操作结果
      */
     @PutMapping("/update")
     public Result updateById(@RequestBody Cart cart) {
@@ -56,7 +64,9 @@ public class CartController {
     }
 
     /**
-     * 根据ID查询
+     * 根据ID查询购物车项
+     * @param id 购物车项ID
+     * @return 购物车项信息
      */
     @GetMapping("/selectById/{id}")
     public Result selectById(@PathVariable Integer id) {
@@ -65,7 +75,9 @@ public class CartController {
     }
 
     /**
-     * 查询所有
+     * 查询所有购物车项
+     * @param cart 购物车项查询条件
+     * @return 购物车项列表
      */
     @GetMapping("/selectAll")
     public Result selectAll(Cart cart ) {
@@ -74,7 +86,11 @@ public class CartController {
     }
 
     /**
-     * 分页查询
+     * 分页查询购物车项
+     * @param cart 购物车项查询条件
+     * @param pageNum 页码
+     * @param pageSize 每页数量
+     * @return 分页查询结果
      */
     @GetMapping("/selectPage")
     public Result selectPage(Cart cart,
@@ -84,4 +100,4 @@ public class CartController {
         return Result.success(page);
     }
 
-}
+}

SuperRice/springboot/src/main/java/com/example/controller/CollectController.java

@@ -10,8 +10,9 @@ import javax.annotation.Resource;
 import java.util.List;
 
 /**
- * 收藏前端操作接口
- **/
+ * CollectController类负责处理与收藏功能相关的前端请求。
+ * 它使用CollectService来执行具体的业务逻辑操作。
+ */
 @RestController
 @RequestMapping("/collect")
 public class CollectController {
@@ -20,7 +21,10 @@ public class CollectController {
     private CollectService collectService;
 
     /**
-     * 新增
+     * 新增收藏项。
+     *
+     * @param collect 待添加的收藏项信息，包含用户ID和被收藏项的ID等信息。
+     * @return 返回操作结果，成功则返回成功信息。
      */
     @PostMapping("/add")
     public Result add(@RequestBody Collect collect) {
@@ -29,7 +33,10 @@ public class CollectController {
     }
 
     /**
-     * 删除
+     * 根据ID删除收藏项。
+     *
+     * @param id 要删除的收藏项的ID。
+     * @return 返回操作结果，成功则返回成功信息。
      */
     @DeleteMapping("/delete/{id}")
     public Result deleteById(@PathVariable Integer id) {
@@ -38,7 +45,10 @@ public class CollectController {
     }
 
     /**
-     * 批量删除
+     * 批量删除收藏项。
+     *
+     * @param ids 要删除的收藏项的ID列表。
+     * @return 返回操作结果，成功则返回成功信息。
      */
     @DeleteMapping("/delete/batch")
     public Result deleteBatch(@RequestBody List<Integer> ids) {
@@ -47,7 +57,10 @@ public class CollectController {
     }
 
     /**
-     * 修改
+     * 修改收藏项信息。
+     *
+     * @param collect 包含要修改的收藏项的新信息。
+     * @return 返回操作结果，成功则返回成功信息。
      */
     @PutMapping("/update")
     public Result updateById(@RequestBody Collect collect) {
@@ -56,7 +69,10 @@ public class CollectController {
     }
 
     /**
-     * 根据ID查询
+     * 根据ID查询收藏项信息。
+     *
+     * @param id 要查询的收藏项的ID。
+     * @return 返回查询结果，包括收藏项的详细信息。
      */
     @GetMapping("/selectById/{id}")
     public Result selectById(@PathVariable Integer id) {
@@ -65,7 +81,10 @@ public class CollectController {
     }
 
     /**
-     * 查询所有
+     * 查询所有收藏项。
+     *
+     * @param collect 可选参数，用于指定查询条件，如用户ID。
+     * @return 返回所有符合条件的收藏项列表。
      */
     @GetMapping("/selectAll")
     public Result selectAll(Collect collect ) {
@@ -74,7 +93,12 @@ public class CollectController {
     }
 
     /**
-     * 分页查询
+     * 分页查询收藏项。
+     *
+     * @param collect 可选参数，用于指定查询条件，如用户ID。
+     * @param pageNum 当前页码，默认为1。
+     * @param pageSize 每页大小，默认为10。
+     * @return 返回分页查询结果，包括总页数、总记录数及当前页的收藏项列表。
      */
     @GetMapping("/selectPage")
     public Result selectPage(Collect collect,
@@ -84,4 +108,4 @@ public class CollectController {
         return Result.success(page);
     }
 
-}
+}

SuperRice/springboot/src/main/java/com/example/controller/CommentController.java

@@ -20,7 +20,10 @@ public class CommentController {
     private CommentService commentService;
 
     /**
-     * 新增
+     * 新增评论
+     *
+     * @param comment 评论对象，包含要添加的评论信息
+     * @return 操作结果，成功返回成功信息
      */
     @PostMapping("/add")
     public Result add(@RequestBody Comment comment) {
@@ -29,7 +32,10 @@ public class CommentController {
     }
 
     /**
-     * 删除
+     * 删除评论
+     *
+     * @param id 评论ID，用于标识要删除的评论
+     * @return 操作结果，成功返回成功信息
      */
     @DeleteMapping("/delete/{id}")
     public Result deleteById(@PathVariable Integer id) {
@@ -38,7 +44,10 @@ public class CommentController {
     }
 
     /**
-     * 批量删除
+     * 批量删除评论
+     *
+     * @param ids 评论ID列表，用于标识要批量删除的评论
+     * @return 操作结果，成功返回成功信息
      */
     @DeleteMapping("/delete/batch")
     public Result deleteBatch(@RequestBody List<Integer> ids) {
@@ -47,7 +56,10 @@ public class CommentController {
     }
 
     /**
-     * 修改
+     * 修改评论信息
+     *
+     * @param comment 评论对象，包含要更新的评论信息
+     * @return 操作结果，成功返回成功信息
      */
     @PutMapping("/update")
     public Result updateById(@RequestBody Comment comment) {
@@ -56,7 +68,10 @@ public class CommentController {
     }
 
     /**
-     * 根据ID查询
+     * 根据ID查询评论
+     *
+     * @param id 评论ID，用于标识要查询的评论
+     * @return 查询结果，返回评论对象
      */
     @GetMapping("/selectById/{id}")
     public Result selectById(@PathVariable Integer id) {
@@ -64,6 +79,12 @@ public class CommentController {
         return Result.success(comment);
     }
 
+    /**
+     * 根据商品ID查询评论列表
+     *
+     * @param id 商品ID，用于标识要查询的商品
+     * @return 查询结果，返回评论列表
+     */
     @GetMapping("/selectByGoodsId")
     public Result selectByGoodsId(@RequestParam Integer id) {
         List<Comment> list =  commentService.selectByGoodsId(id);
@@ -71,7 +92,10 @@ public class CommentController {
     }
 
     /**
-     * 查询所有
+     * 查询所有评论
+     *
+     * @param comment 评论对象，用于指定查询条件
+     * @return 查询结果，返回评论列表
      */
     @GetMapping("/selectAll")
     public Result selectAll(Comment comment ) {
@@ -80,7 +104,12 @@ public class CommentController {
     }
 
     /**
-     * 分页查询
+     * 分页查询评论
+     *
+     * @param comment 评论对象，用于指定查询条件
+     * @param pageNum 页码，用于指定当前页
+     * @param pageSize 每页大小，用于指定每页记录数
+     * @return 查询结果，返回分页信息
      */
     @GetMapping("/selectPage")
     public Result selectPage(Comment comment,
@@ -90,4 +119,4 @@ public class CommentController {
         return Result.success(page);
     }
 
-}
+}

SuperRice/springboot/src/main/java/com/example/controller/FileController.java

@@ -27,14 +27,19 @@ public class FileController {
     // 文件上传存储路径
     private static final String filePath = System.getProperty("user.dir") + "/files/";
 
+    // 服务器端口
     @Value("${server.port:9090}")
     private String port;
 
+    // 服务器IP
     @Value("${ip:localhost}")
     private String ip;
 
     /**
      * 文件上传
+     *
+     * @param file 要上传的文件
+     * @return 文件上传结果
      */
     @PostMapping("/upload")
     public Result upload(MultipartFile file) {
@@ -59,12 +64,11 @@ public class FileController {
         return Result.success(http + flag + "-" + fileName);  //  http://localhost:9090/files/1697438073596-avatar.png
     }
 
-
     /**
      * 获取文件
      *
-     * @param flag
-     * @param response
+     * @param flag 文件标识
+     * @param response HTTP响应
      */
     @GetMapping("/{flag}")   //  1697438073596-avatar.png
     public void avatarPath(@PathVariable String flag, HttpServletResponse response) {
@@ -87,7 +91,7 @@ public class FileController {
     /**
      * 删除文件
      *
-     * @param flag
+     * @param flag 文件标识
      */
     @DeleteMapping("/{flag}")
     public void delFile(@PathVariable String flag) {
@@ -97,6 +101,9 @@ public class FileController {
 
     /**
      * wang-editor编辑器文件上传接口
+     *
+     * @param file 要上传的文件
+     * @return 文件上传结果
      */
     @PostMapping("/wang/upload")
     public Map<String, Object> wangEditorUpload(MultipartFile file) {

SuperRice/springboot/src/main/java/com/example/controller/GoodsController.java

@@ -20,7 +20,9 @@ public class GoodsController {
     private GoodsService goodsService;
 
     /**
-     * 新增
+     * 新增商品信息
+     * @param goods 商品对象
+     * @return 操作结果
      */
     @PostMapping("/add")
     public Result add(@RequestBody Goods goods) {
@@ -29,7 +31,9 @@ public class GoodsController {
     }
 
     /**
-     * 删除
+     * 根据ID删除商品信息
+     * @param id 商品ID
+     * @return 操作结果
      */
     @DeleteMapping("/delete/{id}")
     public Result deleteById(@PathVariable Integer id) {
@@ -38,7 +42,9 @@ public class GoodsController {
     }
 
     /**
-     * 批量删除
+     * 批量删除商品信息
+     * @param ids 商品ID列表
+     * @return 操作结果
      */
     @DeleteMapping("/delete/batch")
     public Result deleteBatch(@RequestBody List<Integer> ids) {
@@ -47,7 +53,9 @@ public class GoodsController {
     }
 
     /**
-     * 修改
+     * 修改商品信息
+     * @param goods 商品对象
+     * @return 操作结果
      */
     @PutMapping("/update")
     public Result updateById(@RequestBody Goods goods) {
@@ -56,13 +64,20 @@ public class GoodsController {
     }
 
     /**
-     * 根据ID查询
+     * 根据ID查询商品信息
+     * @param id 商品ID
+     * @return 商品信息
      */
     @GetMapping("/selectById")
     public Result selectById(@RequestParam Integer id) {
         Goods goods = goodsService.selectById(id);
         return Result.success(goods);
     }
+
+    /**
+     * 查询前15条商品信息
+     * @return 商品信息列表
+     */
     @GetMapping("/selectTop15")
     public Result selectTop15() {
         List<Goods> list = goodsService.selectTop15();
@@ -70,7 +85,9 @@ public class GoodsController {
     }
 
     /**
-     * 查询所有
+     * 查询所有商品信息
+     * @param goods 商品对象，用于条件查询
+     * @return 商品信息列表
      */
     @GetMapping("/selectAll")
     public Result selectAll(Goods goods ) {
@@ -78,18 +95,33 @@ public class GoodsController {
         return Result.success(list);
     }
 
+    /**
+     * 根据类型ID查询商品信息
+     * @param id 类型ID
+     * @return 商品信息列表
+     */
     @GetMapping("/selectByTypeId")
     public Result selectByTypeId(@RequestParam Integer id) {
         List<Goods> list = goodsService.selectByTypeId(id);
         return Result.success(list);
     }
 
+    /**
+     * 根据名称查询商品信息
+     * @param name 商品名称
+     * @return 商品信息列表
+     */
     @GetMapping("/selectByName")
     public Result selectByName(@RequestParam String name) {
         List<Goods> list = goodsService.selectByName(name);
         return Result.success(list);
     }
 
+    /**
+     * 根据商家ID查询商品信息
+     * @param id 商家ID
+     * @return 商品信息列表
+     */
     @GetMapping("/selectByBusinessId")
     public Result selectByBusinessId(@RequestParam Integer id) {
         List<Goods> list = goodsService.selectByBusinessId(id);
@@ -97,7 +129,11 @@ public class GoodsController {
     }
 
     /**
-     * 分页查询
+     * 分页查询商品信息
+     * @param goods 商品对象，用于条件查询
+     * @param pageNum 页码
+     * @param pageSize 每页大小
+     * @return 分页查询结果
      */
     @GetMapping("/selectPage")
     public Result selectPage(Goods goods,
@@ -107,4 +143,4 @@ public class GoodsController {
         return Result.success(page);
     }
 
-}
+}

SuperRice/springboot/src/main/java/com/example/controller/NoticeController.java

@@ -19,7 +19,9 @@ public class NoticeController {
     private NoticeService noticeService;
 
     /**
-     * 新增
+     * 新增公告信息
+     * @param notice 公告对象
+     * @return 操作结果
      */
     @PostMapping("/add")
     public Result add(@RequestBody Notice notice) {
@@ -28,7 +30,9 @@ public class NoticeController {
     }
 
     /**
-     * 删除
+     * 根据ID删除公告信息
+     * @param id 公告ID
+     * @return 操作结果
      */
     @DeleteMapping("/delete/{id}")
     public Result deleteById(@PathVariable Integer id) {
@@ -37,7 +41,9 @@ public class NoticeController {
     }
 
     /**
-     * 批量删除
+     * 批量删除公告信息
+     * @param ids 公告ID列表
+     * @return 操作结果
      */
     @DeleteMapping("/delete/batch")
     public Result deleteBatch(@RequestBody List<Integer> ids) {
@@ -46,7 +52,9 @@ public class NoticeController {
     }
 
     /**
-     * 修改
+     * 修改公告信息
+     * @param notice 公告对象
+     * @return 操作结果
      */
     @PutMapping("/update")
     public Result updateById(@RequestBody Notice notice) {
@@ -55,7 +63,9 @@ public class NoticeController {
     }
 
     /**
-     * 根据ID查询
+     * 根据ID查询公告信息
+     * @param id 公告ID
+     * @return 公告对象
      */
     @GetMapping("/selectById/{id}")
     public Result selectById(@PathVariable Integer id) {
@@ -64,7 +74,9 @@ public class NoticeController {
     }
 
     /**
-     * 查询所有
+     * 查询所有公告信息
+     * @param notice 公告对象，用于条件查询
+     * @return 公告列表
      */
     @GetMapping("/selectAll")
     public Result selectAll(Notice notice ) {
@@ -73,7 +85,11 @@ public class NoticeController {
     }
 
     /**
-     * 分页查询
+     * 分页查询公告信息
+     * @param notice 公告对象，用于条件查询
+     * @param pageNum 页码
+     * @param pageSize 每页大小
+     * @return 分页的公告信息
      */
     @GetMapping("/selectPage")
     public Result selectPage(Notice notice,
@@ -83,4 +99,4 @@ public class NoticeController {
         return Result.success(page);
     }
 
-}
+}

SuperRice/springboot/src/main/java/com/example/controller/OrdersController.java

@@ -20,7 +20,9 @@ public class OrdersController {
     private OrdersService ordersService;
 
     /**
-     * 新增
+     * 新增订单
+     * @param orders 订单对象
+     * @return 操作结果
      */
     @PostMapping("/add")
     public Result add(@RequestBody Orders orders) {
@@ -29,7 +31,9 @@ public class OrdersController {
     }
 
     /**
-     * 删除
+     * 根据ID删除订单
+     * @param id 订单ID
+     * @return 操作结果
      */
     @DeleteMapping("/delete/{id}")
     public Result deleteById(@PathVariable Integer id) {
@@ -38,7 +42,9 @@ public class OrdersController {
     }
 
     /**
-     * 批量删除
+     * 批量删除订单
+     * @param ids 订单ID列表
+     * @return 操作结果
      */
     @DeleteMapping("/delete/batch")
     public Result deleteBatch(@RequestBody List<Integer> ids) {
@@ -47,7 +53,9 @@ public class OrdersController {
     }
 
     /**
-     * 修改
+     * 修改订单信息
+     * @param orders 订单对象
+     * @return 操作结果
      */
     @PutMapping("/update")
     public Result updateById(@RequestBody Orders orders) {
@@ -56,7 +64,9 @@ public class OrdersController {
     }
 
     /**
-     * 根据ID查询
+     * 根据ID查询订单
+     * @param id 订单ID
+     * @return 订单对象
      */
     @GetMapping("/selectById/{id}")
     public Result selectById(@PathVariable Integer id) {
@@ -65,7 +75,9 @@ public class OrdersController {
     }
 
     /**
-     * 查询所有
+     * 查询所有订单
+     * @param orders 订单对象，用于传递查询条件
+     * @return 订单列表
      */
     @GetMapping("/selectAll")
     public Result selectAll(Orders orders ) {
@@ -74,7 +86,11 @@ public class OrdersController {
     }
 
     /**
-     * 分页查询
+     * 分页查询订单
+     * @param orders 订单对象，用于传递查询条件
+     * @param pageNum 当前页码
+     * @param pageSize 每页大小
+     * @return 分页信息
      */
     @GetMapping("/selectPage")
     public Result selectPage(Orders orders,
@@ -84,4 +100,4 @@ public class OrdersController {
         return Result.success(page);
     }
 
-}
+}

SuperRice/springboot/src/main/java/com/example/controller/TypeController.java

@@ -20,7 +20,9 @@ public class TypeController {
     private TypeService typeService;
 
     /**
-     * 新增
+     * 新增公告信息
+     * @param type 待添加的公告信息对象
+     * @return 操作结果，返回成功状态
      */
     @PostMapping("/add")
     public Result add(@RequestBody Type type) {
@@ -29,7 +31,9 @@ public class TypeController {
     }
 
     /**
-     * 删除
+     * 根据ID删除公告信息
+     * @param id 待删除的公告信息的ID
+     * @return 操作结果，返回成功状态
      */
     @DeleteMapping("/delete/{id}")
     public Result deleteById(@PathVariable Integer id) {
@@ -38,7 +42,9 @@ public class TypeController {
     }
 
     /**
-     * 批量删除
+     * 批量删除公告信息
+     * @param ids 待删除的公告信息的ID列表
+     * @return 操作结果，返回成功状态
      */
     @DeleteMapping("/delete/batch")
     public Result deleteBatch(@RequestBody List<Integer> ids) {
@@ -47,7 +53,9 @@ public class TypeController {
     }
 
     /**
-     * 修改
+     * 修改公告信息
+     * @param type 待修改的公告信息对象，包含修改后的数据
+     * @return 操作结果，返回成功状态
      */
     @PutMapping("/update")
     public Result updateById(@RequestBody Type type) {
@@ -56,7 +64,9 @@ public class TypeController {
     }
 
     /**
-     * 根据ID查询
+     * 根据ID查询公告信息
+     * @param id 待查询的公告信息的ID
+     * @return 查询结果，返回包含公告信息对象的成功状态
      */
     @GetMapping("/selectById/{id}")
     public Result selectById(@PathVariable Integer id) {
@@ -65,7 +75,9 @@ public class TypeController {
     }
 
     /**
-     * 查询所有
+     * 查询所有公告信息
+     * @param type 查询条件对象，可选
+     * @return 查询结果，返回包含公告信息列表的成功状态
      */
     @GetMapping("/selectAll")
     public Result selectAll(Type type ) {
@@ -74,7 +86,11 @@ public class TypeController {
     }
 
     /**
-     * 分页查询
+     * 分页查询公告信息
+     * @param type 查询条件对象，可选
+     * @param pageNum 页码，默认为1
+     * @param pageSize 每页大小，默认为10
+     * @return 查询结果，返回包含分页信息的成功状态
      */
     @GetMapping("/selectPage")
     public Result selectPage(Type type,
@@ -84,4 +100,4 @@ public class TypeController {
         return Result.success(page);
     }
 
-}
+}

SuperRice/springboot/src/main/java/com/example/controller/UserController.java

@@ -1,9 +1,7 @@
 package com.example.controller;
 
 import com.example.common.Result;
-import com.example.entity.Business;
 import com.example.entity.User;
-import com.example.service.BusinessService;
 import com.example.service.UserService;
 import com.github.pagehelper.PageInfo;
 import org.springframework.web.bind.annotation.*;
@@ -22,7 +20,9 @@ public class UserController {
     private UserService userService;
 
     /**
-     * 新增
+     * 新增用户
+     * @param user 待添加的用户对象
+     * @return 返回结果对象，表示操作是否成功
      */
     @PostMapping("/add")
     public Result add(@RequestBody User user) {
@@ -31,7 +31,9 @@ public class UserController {
     }
 
     /**
-     * 删除
+     * 根据ID删除用户
+     * @param id 用户ID
+     * @return 返回结果对象，表示操作是否成功
      */
     @DeleteMapping("/delete/{id}")
     public Result deleteById(@PathVariable Integer id) {
@@ -40,7 +42,9 @@ public class UserController {
     }
 
     /**
-     * 批量删除
+     * 批量删除用户
+     * @param ids 用户ID列表
+     * @return 返回结果对象，表示操作是否成功
      */
     @DeleteMapping("/delete/batch")
     public Result deleteBatch(@RequestBody List<Integer> ids) {
@@ -49,7 +53,9 @@ public class UserController {
     }
 
     /**
-     * 修改
+     * 修改用户信息
+     * @param user 待修改的用户对象
+     * @return 返回结果对象，表示操作是否成功
      */
     @PutMapping("/update")
     public Result updateById(@RequestBody User user) {
@@ -58,7 +64,9 @@ public class UserController {
     }
 
     /**
-     * 根据ID查询
+     * 根据ID查询用户
+     * @param id 用户ID
+     * @return 返回结果对象，包含查询到的用户信息
      */
     @GetMapping("/selectById/{id}")
     public Result selectById(@PathVariable Integer id) {
@@ -67,7 +75,9 @@ public class UserController {
     }
 
     /**
-     * 查询所有
+     * 查询所有用户
+     * @param user 用户对象，用于传递查询条件
+     * @return 返回结果对象，包含所有用户信息列表
      */
     @GetMapping("/selectAll")
     public Result selectAll(User user ) {
@@ -76,7 +86,11 @@ public class UserController {
     }
 
     /**
-     * 分页查询
+     * 分页查询用户
+     * @param user 用户对象，用于传递查询条件
+     * @param pageNum 页码，默认为1
+     * @param pageSize 每页大小，默认为10
+     * @return 返回结果对象，包含分页查询结果
      */
     @GetMapping("/selectPage")
     public Result selectPage(User user,
@@ -86,4 +100,4 @@ public class UserController {
         return Result.success(page);
     }
 
-}
+}

SuperRice/springboot/src/main/java/com/example/controller/WebController.java

@@ -26,20 +26,30 @@ public class WebController {
     @Resource
     private UserService userService;
 
+    /**
+     * 根路径访问
+     *
+     * @return 成功信息
+     */
     @GetMapping("/")
     public Result hello() {
         return Result.success("访问成功");
     }
 
     /**
-     * 登录
+     * 用户登录接口
+     *
+     * @param account 用户账户信息，包括用户名、密码和角色
+     * @return 登录结果，包含用户信息
      */
     @PostMapping("/login")
     public Result login(@RequestBody Account account) {
+        // 检查登录参数是否完整
         if (ObjectUtil.isEmpty(account.getUsername()) || ObjectUtil.isEmpty(account.getPassword())
                 || ObjectUtil.isEmpty(account.getRole())) {
             return Result.error(ResultCodeEnum.PARAM_LOST_ERROR);
         }
+        // 根据用户角色调用相应的登录方法
         if (RoleEnum.ADMIN.name().equals(account.getRole())) {
             account = adminService.login(account);
         }
@@ -53,14 +63,19 @@ public class WebController {
     }
 
     /**
-     * 注册
+     * 用户注册接口
+     *
+     * @param account 用户账户信息，包括用户名、密码和角色
+     * @return 注册结果
      */
     @PostMapping("/register")
     public Result register(@RequestBody Account account) {
+        // 检查注册参数是否完整
         if (StrUtil.isBlank(account.getUsername()) || StrUtil.isBlank(account.getPassword())
                 || ObjectUtil.isEmpty(account.getRole())) {
             return Result.error(ResultCodeEnum.PARAM_LOST_ERROR);
         }
+        // 根据用户角色调用相应的注册方法
         if (RoleEnum.ADMIN.name().equals(account.getRole())) {
             adminService.register(account);
         }
@@ -74,14 +89,19 @@ public class WebController {
     }
 
     /**
-     * 修改密码
+     * 修改密码接口
+     *
+     * @param account 用户账户信息，包括用户名、当前密码和新密码
+     * @return 修改密码结果
      */
     @PutMapping("/updatePassword")
     public Result updatePassword(@RequestBody Account account) {
+        // 检查修改密码参数是否完整
         if (StrUtil.isBlank(account.getUsername()) || StrUtil.isBlank(account.getPassword())
                 || ObjectUtil.isEmpty(account.getNewPassword())) {
             return Result.error(ResultCodeEnum.PARAM_LOST_ERROR);
         }
+        // 根据用户角色调用相应的修改密码方法
         if (RoleEnum.ADMIN.name().equals(account.getRole())) {
             adminService.updatePassword(account);
         }

SuperRice/springboot/src/main/java/com/example/entity/Account.java

@@ -4,6 +4,7 @@ package com.example.entity;
  * 角色用户父类
  */
 public class Account {
+    // 用户唯一标识
     private Integer id;
     /** 用户名 */
     private String username;
@@ -18,68 +19,133 @@ public class Account {
     /** 头像 */
     private String avatar;
 
+    // 用户认证令牌
     private String token;
 
+    /**
+     * 获取用户ID
+     * @return 用户ID
+     */
     public Integer getId() {
         return id;
     }
 
+    /**
+     * 设置用户ID
+     * @param id 用户ID
+     */
     public void setId(Integer id) {
         this.id = id;
     }
 
+    /**
+     * 获取用户名
+     * @return 用户名
+     */
     public String getUsername() {
         return username;
     }
 
+    /**
+     * 设置用户名
+     * @param username 用户名
+     */
     public void setUsername(String username) {
         this.username = username;
     }
 
+    /**
+     * 获取用户名称
+     * @return 用户名称
+     */
     public String getName() {
         return name;
     }
 
+    /**
+     * 设置用户名称
+     * @param name 用户名称
+     */
     public void setName(String name) {
         this.name = name;
     }
 
+    /**
+     * 获取用户密码
+     * @return 用户密码
+     */
     public String getPassword() {
         return password;
     }
 
+    /**
+     * 设置用户密码
+     * @param password 用户密码
+     */
     public void setPassword(String password) {
         this.password = password;
     }
 
+    /**
+     * 获取用户角色
+     * @return 用户角色
+     */
     public String getRole() {
         return role;
     }
 
+    /**
+     * 设置用户角色
+     * @param role 用户角色
+     */
     public void setRole(String role) {
         this.role = role;
     }
 
+    /**
+     * 获取用户新密码
+     * @return 用户新密码
+     */
     public String getNewPassword() {
         return newPassword;
     }
 
+    /**
+     * 设置用户新密码
+     * @param newPassword 用户新密码
+     */
     public void setNewPassword(String newPassword) {
         this.newPassword = newPassword;
     }
 
+    /**
+     * 获取用户头像
+     * @return 用户头像
+     */
     public String getAvatar() {
         return avatar;
     }
 
+    /**
+     * 设置用户头像
+     * @param avatar 用户头像
+     */
     public void setAvatar(String avatar) {
         this.avatar = avatar;
     }
 
+    /**
+     * 获取用户认证令牌
+     * @return 用户认证令牌
+     */
     public String getToken() {
         return token;
     }
 
+    /**
+     * 设置用户认证令牌
+     * @param token 用户认证令牌
+     */
     public void setToken(String token) {
         this.token = token;
     }

SuperRice/springboot/src/main/java/com/example/entity/Address.java

@@ -4,7 +4,7 @@ import java.io.Serializable;
 
 /**
  * 地址信息表
-*/
+ */
 public class Address implements Serializable {
     private static final long serialVersionUID = 1L;
 
@@ -14,46 +14,93 @@ public class Address implements Serializable {
     private String useraddress;
     private String phone;
 
-
+    /**
+     * 获取地址ID
+     *
+     * @return 地址ID
+     */
     public Integer getId() {
         return id;
     }
 
+    /**
+     * 设置地址ID
+     *
+     * @param id 地址ID
+     */
     public void setId(Integer id) {
         this.id = id;
     }
 
+    /**
+     * 获取用户ID
+     *
+     * @return 用户ID
+     */
     public Integer getUserId() {
         return userId;
     }
 
+    /**
+     * 设置用户ID
+     *
+     * @param userId 用户ID
+     */
     public void setUserId(Integer userId) {
         this.userId = userId;
     }
 
+    /**
+     * 获取用户名
+     *
+     * @return 用户名
+     */
     public String getUsername() {
         return username;
     }
 
+    /**
+     * 设置用户名
+     *
+     * @param username 用户名
+     */
     public void setUsername(String username) {
         this.username = username;
     }
 
+    /**
+     * 获取用户地址
+     *
+     * @return 用户地址
+     */
     public String getUseraddress() {
         return useraddress;
     }
 
+    /**
+     * 设置用户地址
+     *
+     * @param useraddress 用户地址
+     */
     public void setUseraddress(String useraddress) {
         this.useraddress = useraddress;
     }
 
+    /**
+     * 获取电话号码
+     *
+     * @return 电话号码
+     */
     public String getPhone() {
         return phone;
     }
 
+    /**
+     * 设置电话号码
+     *
+     * @param phone 电话号码
+     */
     public void setPhone(String phone) {
         this.phone = phone;
     }
 }
-
-