📝 docs(controller): 移除控制器类中的作者注释

YunaiV
1 parent ef19ad39
Showing 15 changed files with 65 additions and 63 deletions
yudao-module-im/yudao-module-im-biz/src/main/java/cn/iocoder/yudao/module/im/controller/admin/friend/ImFriendController.java
yudao-module-im/yudao-module-im-biz/src/main/java/cn/iocoder/yudao/module/im/controller/admin/message/ImGroupMessageController.java
yudao-module-im/yudao-module-im-biz/src/main/java/cn/iocoder/yudao/module/im/controller/admin/message/ImPrivateMessageController.java
yudao-module-mes/src/main/java/cn/iocoder/yudao/module/mes/controller/admin/wm/miscreceipt/MesWmMiscReceiptController.java
yudao-module-mes/src/main/java/cn/iocoder/yudao/module/mes/controller/admin/wm/miscreceipt/MesWmMiscReceiptLineController.java
yudao-module-mes/src/main/java/cn/iocoder/yudao/module/mes/controller/admin/wm/outsourceissue/MesWmOutsourceIssueController.java
yudao-module-mes/src/main/java/cn/iocoder/yudao/module/mes/controller/admin/wm/outsourceissue/MesWmOutsourceIssueDetailController.java
yudao-module-mes/src/main/java/cn/iocoder/yudao/module/mes/controller/admin/wm/outsourceissue/MesWmOutsourceIssueLineController.java
yudao-module-mes/src/main/java/cn/iocoder/yudao/module/mes/controller/admin/wm/packages/MesWmPackageController.java
yudao-module-mes/src/main/java/cn/iocoder/yudao/module/mes/controller/admin/wm/packages/MesWmPackageLineController.java
yudao-module-mes/src/main/java/cn/iocoder/yudao/module/mes/controller/admin/wm/returnsales/MesWmReturnSalesController.java
yudao-module-mes/src/main/java/cn/iocoder/yudao/module/mes/controller/admin/wm/returnsales/MesWmReturnSalesDetailController.java
yudao-module-mes/src/main/java/cn/iocoder/yudao/module/mes/controller/admin/wm/returnsales/MesWmReturnSalesLineController.java
yudao-module-pay/src/main/java/cn/iocoder/yudao/module/pay/controller/app/wallet/AppPayWalletController.java
yudao-module-system/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/PermissionController.java
+package cn.iocoder.yudao.module.im.controller.admin.friend;
+
+import cn.iocoder.yudao.framework.common.pojo.CommonResult;
+import cn.iocoder.yudao.framework.security.core.util.SecurityFrameworkUtils;
+import cn.iocoder.yudao.module.im.controller.admin.friend.vo.ImFriendRespVO;
+import cn.iocoder.yudao.module.im.service.friend.ImFriendService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import jakarta.annotation.Resource;
+import jakarta.validation.constraints.NotNull;
+import org.springframework.validation.annotation.Validated;
+import org.springframework.web.bind.annotation.*;
+
+import java.util.List;
+
+import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
+
+@Tag(name = "管理后台 - IM 好友")
+@RestController
+@RequestMapping("/im/friend")
+@Validated
+public class ImFriendController {
+
+    @Resource
+    private ImFriendService friendService;
+
+    @GetMapping("/list")
+    @Operation(summary = "获得当前登录用户的好友列表")
+    public CommonResult<List<ImFriendRespVO>> getMyFriendList() {
+        Long userId = SecurityFrameworkUtils.getLoginUserId();
+        return success(friendService.getMyFriendList(userId));
+    }
+
+    @GetMapping("/get")
+    @Operation(summary = "获得好友详情")
+    @Parameter(name = "friendUserId", description = "好友的用户编号", required = true, example = "2048")
+    public CommonResult<ImFriendRespVO> getFriend(@RequestParam("friendUserId") Long friendUserId) {
+        Long userId = SecurityFrameworkUtils.getLoginUserId();
+        return success(friendService.getFriend(userId, friendUserId));
+    }
+
+    @PostMapping("/add")
+    @Operation(summary = "添加好友（双向建立关系）")
+    @Parameter(name = "friendUserId", description = "好友的用户编号", required = true, example = "2048")
+    public CommonResult<Boolean> addFriend(
+            @RequestParam("friendUserId") @NotNull(message = "好友用户编号不能为空") Long friendUserId) {
+        Long userId = SecurityFrameworkUtils.getLoginUserId();
+        friendService.addFriend(userId, friendUserId);
+        return success(true);
+    }
+
+    @DeleteMapping("/delete")
+    @Operation(summary = "删除好友（双向软删除）")
+    @Parameter(name = "friendUserId", description = "好友的用户编号", required = true, example = "2048")
+    public CommonResult<Boolean> deleteFriend(
+            @RequestParam("friendUserId") @NotNull(message = "好友用户编号不能为空") Long friendUserId) {
+        Long userId = SecurityFrameworkUtils.getLoginUserId();
+        friendService.deleteFriend(userId, friendUserId);
+        return success(true);
+    }
+
+    // TODO @AI：增加一个 updateFriend 接口，目前暂时就 dnd（免打扰）功能，后续可以增加备注等功能
+
+}
@@ -20,9 +20,6 @@ import java.util.List;
 import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
 import static cn.iocoder.yudao.framework.security.core.util.SecurityFrameworkUtils.getLoginUserId;
-/**
- * 管理后台 - IM 群聊消息
- */
 @Tag(name = "管理后台 - IM 群聊消息")
 @RestController
 @RequestMapping("/im/message/group")
@@ -20,9 +20,6 @@ import java.util.List;
 import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
 import static cn.iocoder.yudao.framework.security.core.util.SecurityFrameworkUtils.getLoginUserId;
-/**
- * 管理后台 - IM 私聊消息
- */
 @Tag(name = "管理后台 - IM 私聊消息")
 @RestController
 @RequestMapping("/im/message/private")
@@ -26,11 +26,6 @@ import java.util.List;
 import static cn.iocoder.yudao.framework.apilog.core.enums.OperateTypeEnum.EXPORT;
 import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
-/**
- * MES 杂项入库单 Controller
- *
- * @author 芋道源码
- */
 @Tag(name = "管理后台 - MES 杂项入库单")
 @RestController
 @RequestMapping("/mes/wm/misc-receipt")
@@ -36,9 +36,6 @@ import cn.iocoder.yudao.module.mes.service.wm.warehouse.MesWmWarehouseService;
 import cn.iocoder.yudao.module.mes.service.wm.warehouse.MesWmWarehouseLocationService;
 import cn.iocoder.yudao.module.mes.service.wm.warehouse.MesWmWarehouseAreaService;
-/**
- * MES 杂项入库单行 Controller
- */
 @Tag(name = "管理后台 - MES 杂项入库单行")
 @RestController
 @RequestMapping("/mes/wm/misc-receipt-line")
@@ -36,11 +36,6 @@ import static cn.iocoder.yudao.framework.apilog.core.enums.OperateTypeEnum.EXPOR
 import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
 import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.convertSet;
-/**
- * MES 外协发料单 Controller
- *
- * @author 芋道源码
- */
 @Tag(name = "管理后台 - MES 外协发料单")
 @RestController
 @RequestMapping("/mes/wm/outsource-issue")
@@ -34,11 +34,6 @@ import java.util.Map;
 import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
 import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.convertSet;
-/**
- * MES 外协发料单明细 Controller
- *
- * @author 芋道源码
- */
 @Tag(name = "管理后台 - MES 外协发料单明细")
 @RestController
 @RequestMapping("/mes/wm/outsource-issue-detail")
@@ -34,11 +34,6 @@ import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
 import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.convertMap;
 import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.convertSet;
-/**
- * MES 外协发料单行 Controller
- *
- * @author 芋道源码
- */
 @Tag(name = "管理后台 - MES 外协发料单行")
 @RestController
 @RequestMapping("/mes/wm/outsource-issue-line")
@@ -32,12 +32,6 @@ import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
 import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.convertSet;
 import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.convertSetByFlatMap;
-// DONE @AI：检查下 java 类，是不是 author 没加。
-/**
- * MES 装箱单 Controller
- *
- * @author 芋道源码
- */
 @Tag(name = "管理后台 - MES 装箱单")
 @RestController
 @RequestMapping("/mes/wm/package")
@@ -32,11 +32,6 @@ import java.util.Map;
 import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
 import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.convertSet;
-/**
- * MES 装箱明细 Controller
- *
- * @author 芋道源码
- */
 @Tag(name = "管理后台 - MES 装箱明细")
 @RestController
 @RequestMapping("/mes/wm/package-line")
@@ -34,11 +34,6 @@ import static cn.iocoder.yudao.framework.apilog.core.enums.OperateTypeEnum.EXPOR
 import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
 import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.convertSet;
-/**
- * 管理后台 - MES 销售退货单 Controller
- *
- * @author 芋道源码
- */
 @Tag(name = "管理后台 - MES 销售退货单")
 @RestController
 @RequestMapping("/mes/wm/return-sales")
@@ -34,11 +34,6 @@ import java.util.Map;
 import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
 import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.convertSet;
-/**
- * 管理后台 - MES 销售退货相关
- *
- * @author 芋道源码
- */
 @Tag(name = "管理后台 - MES 销售退货明细")
 @RestController
 @RequestMapping("/mes/wm/return-sales-detail")
@@ -30,11 +30,6 @@ import java.util.Map;
 import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
 import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.convertSet;
-/**
- * 管理后台 - MES 销售退货相关
- *
- * @author 芋道源码
- */
 @Tag(name = "管理后台 - MES 销售退货单行")
 @RestController
 @RequestMapping("/mes/wm/return-sales-line")
@@ -19,9 +19,6 @@ import jakarta.annotation.Resource;
 import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
 import static cn.iocoder.yudao.framework.security.core.util.SecurityFrameworkUtils.getLoginUserId;
-/**
- * @author jason
- */
 @Tag(name = "用户 APP - 钱包")
 @RestController
 @RequestMapping("/pay/wallet")
@@ -20,11 +20,6 @@ import java.util.Set;
 import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
-/**
- * 权限 Controller，提供赋予用户、角色的权限的 API 接口
- *
- * @author 芋道源码
- */
 @Tag(name = "管理后台 - 权限")
 @RestController
 @RequestMapping("/system/permission")