营销模块中退款保证

mall-search/src/main/java/com/macro/mall/search/config/SwaggerConfig.java

@@ -8,27 +8,39 @@ import org.springframework.context.annotation.Configuration;
 import springfox.documentation.swagger2.annotations.EnableSwagger2;
 
 /**
- * Swagger API文档相关配置
+ * Swagger API文档相关配置类。
+ * 该类用于配置Swagger，生成API文档。
  * Created by macro on 2018/4/26.
  */
 @Configuration
-@EnableSwagger2
+@EnableSwagger2 // 启用Swagger2
 public class SwaggerConfig extends BaseSwaggerConfig {
 
+    /**
+     * 重写父类方法，返回Swagger属性配置。
+     * @return SwaggerProperties对象，包含Swagger配置信息。
+     */
     @Override
     public SwaggerProperties swaggerProperties() {
+        // 使用SwaggerProperties.builder()构建Swagger配置
         return SwaggerProperties.builder()
-                .apiBasePackage("com.macro.mall.search.controller")
-                .title("mall搜索系统")
-                .description("mall搜索相关接口文档")
-                .contactName("macro")
-                .version("1.0")
-                .enableSecurity(false)
-                .build();
+                .apiBasePackage("com.macro.mall.search.controller") // 指定扫描的API基础包路径
+                .title("mall搜索系统") // 文档标题
+                .description("mall搜索相关接口文档") // 文档描述
+                .contactName("macro") // 联系人名称
+                .version("1.0") // 文档版本
+                .enableSecurity(false) // 是否启用安全配置（如OAuth2）
+                .build(); // 构建并返回SwaggerProperties对象
     }
 
+    /**
+     * 创建并返回一个BeanPostProcessor对象。
+     * 该对象用于处理Springfox的HandlerProvider，以解决Springfox与Spring Boot的兼容性问题。
+     * @return BeanPostProcessor对象。
+     */
     @Bean
     public BeanPostProcessor springfoxHandlerProviderBeanPostProcessor() {
+        // 调用父类方法生成BeanPostProcessor对象
         return generateBeanPostProcessor();
     }
-}
+}

mall-search/src/main/java/com/macro/mall/search/controller/EsProductController.java

@@ -17,17 +17,22 @@ import org.springframework.web.bind.annotation.*;
 import java.util.List;
 
 /**
- * 搜索商品管理Controller
+ * 搜索商品管理Controller。
+ * 该Controller负责处理与搜索商品相关的请求，包括导入商品到ES、删除商品、创建商品、搜索商品等操作。
  * Created by macro on 2018/6/19.
  */
 @Controller
-@Api(tags = "EsProductController")
-@Tag(name = "EsProductController",description = "搜索商品管理")
-@RequestMapping("/esProduct")
+@Api(tags = "EsProductController") // Swagger注解，用于生成API文档
+@Tag(name = "EsProductController", description = "搜索商品管理") // OpenAPI 3注解，用于生成API文档
+@RequestMapping("/esProduct") // 指定Controller的基础路径
 public class EsProductController {
     @Autowired
-    private EsProductService esProductService;
+    private EsProductService esProductService; // 自动注入EsProductService服务
 
+    /**
+     * 导入所有数据库中商品到ES。
+     * @return 导入成功的商品数量。
+     */
     @ApiOperation(value = "导入所有数据库中商品到ES")
     @RequestMapping(value = "/importAll", method = RequestMethod.POST)
     @ResponseBody
@@ -36,6 +41,11 @@ public class EsProductController {
         return CommonResult.success(count);
     }
 
+    /**
+     * 根据id删除商品。
+     * @param id 商品id。
+     * @return 操作结果。
+     */
     @ApiOperation(value = "根据id删除商品")
     @RequestMapping(value = "/delete/{id}", method = RequestMethod.GET)
     @ResponseBody
@@ -44,6 +54,11 @@ public class EsProductController {
         return CommonResult.success(null);
     }
 
+    /**
+     * 根据id批量删除商品。
+     * @param ids 商品id列表。
+     * @return 操作结果。
+     */
     @ApiOperation(value = "根据id批量删除商品")
     @RequestMapping(value = "/delete/batch", method = RequestMethod.POST)
     @ResponseBody
@@ -52,6 +67,11 @@ public class EsProductController {
         return CommonResult.success(null);
     }
 
+    /**
+     * 根据id创建商品。
+     * @param id 商品id。
+     * @return 创建的商品信息。
+     */
     @ApiOperation(value = "根据id创建商品")
     @RequestMapping(value = "/create/{id}", method = RequestMethod.POST)
     @ResponseBody
@@ -64,6 +84,13 @@ public class EsProductController {
         }
     }
 
+    /**
+     * 简单搜索商品。
+     * @param keyword 搜索关键词。
+     * @param pageNum 页码。
+     * @param pageSize 每页大小。
+     * @return 搜索结果分页。
+     */
     @ApiOperation(value = "简单搜索")
     @RequestMapping(value = "/search/simple", method = RequestMethod.GET)
     @ResponseBody
@@ -74,6 +101,16 @@ public class EsProductController {
         return CommonResult.success(CommonPage.restPage(esProductPage));
     }
 
+    /**
+     * 综合搜索、筛选、排序商品。
+     * @param keyword 搜索关键词。
+     * @param brandId 品牌id。
+     * @param productCategoryId 产品分类id。
+     * @param pageNum 页码。
+     * @param pageSize 每页大小。
+     * @param sort 排序字段。
+     * @return 搜索结果分页。
+     */
     @ApiOperation(value = "综合搜索、筛选、排序")
     @ApiImplicitParam(name = "sort", value = "排序字段:0->按相关度；1->按新品；2->按销量；3->价格从低到高；4->价格从高到低",
             defaultValue = "0", allowableValues = "0,1,2,3,4", paramType = "query", dataType = "integer")
@@ -89,6 +126,13 @@ public class EsProductController {
         return CommonResult.success(CommonPage.restPage(esProductPage));
     }
 
+    /**
+     * 根据商品id推荐商品。
+     * @param id 商品id。
+     * @param pageNum 页码。
+     * @param pageSize 每页大小。
+     * @return 推荐商品分页。
+     */
     @ApiOperation(value = "根据商品id推荐商品")
     @RequestMapping(value = "/recommend/{id}", method = RequestMethod.GET)
     @ResponseBody
@@ -99,6 +143,11 @@ public class EsProductController {
         return CommonResult.success(CommonPage.restPage(esProductPage));
     }
 
+    /**
+     * 获取搜索的相关品牌、分类及筛选属性。
+     * @param keyword 搜索关键词。
+     * @return 相关信息。
+     */
     @ApiOperation(value = "获取搜索的相关品牌、分类及筛选属性")
     @RequestMapping(value = "/search/relate", method = RequestMethod.GET)
     @ResponseBody
@@ -106,4 +155,4 @@ public class EsProductController {
         EsProductRelatedInfo productRelatedInfo = esProductService.searchRelatedInfo(keyword);
         return CommonResult.success(productRelatedInfo);
     }
-}
+}