refactor(system): 解耦后端多个控制器统一返回参数格式

解耦后端多个控制器统一返回参数格式

Author: lingview

backend/src/main/java/xyz/lingview/dimstack/controller/AttachmentManagementController.java

@@ -5,9 +5,9 @@
 import org.springframework.web.bind.annotation.*;
 import xyz.lingview.dimstack.annotation.RequiresPermission;
 import xyz.lingview.dimstack.common.ApiResponse;
-import xyz.lingview.dimstack.mapper.UserInformationMapper;
 import xyz.lingview.dimstack.service.AttachmentManagementService;
 import xyz.lingview.dimstack.service.CurrentUserService;
+import xyz.lingview.dimstack.service.UserService;
 
 import java.util.Map;
 
@@ -25,7 +25,7 @@ public class AttachmentManagementController {
     private AttachmentManagementService attachmentManagementService;
 
     @Autowired
-    private UserInformationMapper userInformationMapper;
+    private UserService userService;
 
     @Autowired
     private CurrentUserService currentUserService;
@@ -114,7 +114,7 @@ public ApiResponse<Map<String, Object>> getAttachmentsByUuid(
             @RequestParam(defaultValue = "10") int size,
             HttpServletRequest request) {
         String username = currentUserService.getCurrentUsername();
-        String uuid = userInformationMapper.selectUserUUID(username);
+        String uuid = userService.getUserUUID(username);
 
         Map<String, Object> result = attachmentManagementService.getPageByUuid(uuid, page, size);
         return ApiResponse.success(result);
@@ -130,7 +130,7 @@ public ApiResponse<Map<String, Object>> getDeletedAttachmentsByUuidOnly(
             @RequestParam(defaultValue = "10") int size,
             HttpServletRequest request) {
         String username = currentUserService.getCurrentUsername();
-        String uuid = userInformationMapper.selectUserUUID(username);
+        String uuid = userService.getUserUUID(username);
 
         Map<String, Object> result = attachmentManagementService.getDeletedPageByUuidOnly(uuid, page, size);
         return ApiResponse.success(result);
@@ -146,7 +146,7 @@ public ApiResponse<Map<String, Object>> getAttachmentsByUuidWithDeleted(
             @RequestParam(defaultValue = "10") int size,
             HttpServletRequest request) {
         String username = currentUserService.getCurrentUsername();
-        String uuid = userInformationMapper.selectUserUUID(username);
+        String uuid = userService.getUserUUID(username);
 
         Map<String, Object> result = attachmentManagementService.getPageByUuidWithRecentDeleted(uuid, page, size);
         return ApiResponse.success(result);
@@ -195,7 +195,7 @@ public ApiResponse<Void> deleteAttachment(
             HttpServletRequest request) {
 
         String username = currentUserService.getCurrentUsername();
-        String userUuid = userInformationMapper.selectUserUUID(username);
+        String userUuid = userService.getUserUUID(username);
 
         String attachmentOwnerUuid = attachmentManagementService.getAttachmentOwnerUuid(attachmentId);
         if (attachmentOwnerUuid == null) {
@@ -224,7 +224,7 @@ public ApiResponse<Void> restoreAttachment(
             HttpServletRequest request) {
 
         String username = currentUserService.getCurrentUsername();
-        String userUuid = userInformationMapper.selectUserUUID(username);
+        String userUuid = userService.getUserUUID(username);
 
         String attachmentOwnerUuid = attachmentManagementService.getAttachmentOwnerUuid(attachmentId);
         if (attachmentOwnerUuid == null) {

backend/src/main/java/xyz/lingview/dimstack/controller/CommentController.java

@@ -24,9 +24,10 @@ public class CommentController {
 
     // 获取文章的评论列表
     @GetMapping("/article/{articleAlias}")
-    public List<CommentDTO> getCommentsByArticle(@PathVariable String articleAlias) {
+    public ApiResponse<List<CommentDTO>> getCommentsByArticle(@PathVariable String articleAlias) {
         String username = currentUserService.getCurrentUsername();
-        return commentService.getCommentsByArticleAlias(articleAlias, username);
+        List<CommentDTO> comments = commentService.getCommentsByArticleAlias(articleAlias, username);
+        return ApiResponse.success(comments);
     }
 
     // 添加评论
@@ -46,17 +47,19 @@ public ApiResponse<Void> addComment(@RequestBody AddCommentRequestDTO request) {
     @PostMapping("/{commentId}/like")
     @RequiresPermission({"comments:like", "comments:edit"})
     @RateLimit(window = 60, maxRequests = 5)
-    public void likeComment(@PathVariable String commentId) {
+    public ApiResponse<Void> likeComment(@PathVariable String commentId) {
         String username = currentUserService.getCurrentUsername();
         commentService.likeComment(username, commentId);
+        return ApiResponse.success("点赞成功");
     }
 
     // 删除评论
     @DeleteMapping("/{commentId}")
     @RateLimit(window = 60, maxRequests = 5)
     @RequiresPermission({"comments:delete", "comments:edit"})
-    public void deleteComment(@PathVariable String commentId) {
+    public ApiResponse<Void> deleteComment(@PathVariable String commentId) {
         String username = currentUserService.getCurrentUsername();
         commentService.deleteComment(username, commentId);
+        return ApiResponse.success("删除成功");
     }
-}
+}

backend/src/main/java/xyz/lingview/dimstack/controller/CustomPageController.java

@@ -7,9 +7,9 @@
 import xyz.lingview.dimstack.common.ApiResponse;
 import xyz.lingview.dimstack.dto.request.CustomPageRequest;
 import xyz.lingview.dimstack.dto.response.CustomPageResponse;
-import xyz.lingview.dimstack.mapper.UserInformationMapper;
 import xyz.lingview.dimstack.service.CurrentUserService;
 import xyz.lingview.dimstack.service.CustomPageService;
+import xyz.lingview.dimstack.service.UserService;
 
 import java.util.List;
 
@@ -27,7 +27,7 @@ public class CustomPageController {
     private CustomPageService customPageService;
 
     @Autowired
-    private UserInformationMapper userInformationMapper;
+    private UserService userService;
 
     @Autowired
     private CurrentUserService currentUserService;
@@ -126,7 +126,7 @@ public ApiResponse<List<CustomPageResponse>> getAllCustomPages(HttpServletReques
     private String getCurrentUserUuid(HttpServletRequest request) {
         String username = currentUserService.getCurrentUsername();
         if (username != null) {
-            return userInformationMapper.selectUserUUID(username);
+            return userService.getUserUUID(username);
         }
         return null;
     }

backend/src/main/java/xyz/lingview/dimstack/controller/FaviconController.java

@@ -8,13 +8,13 @@
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RestController;
 import org.springframework.web.client.RestTemplate;
+import xyz.lingview.dimstack.service.SiteConfigService;
 
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.net.URI;
 
 import net.coobird.thumbnailator.Thumbnails;
-import xyz.lingview.dimstack.mapper.SiteConfigMapper;
 
 @Slf4j
 @RestController
@@ -23,11 +23,11 @@ public class FaviconController {
     private final RestTemplate restTemplate = new RestTemplate();
 
     @Autowired
-    private SiteConfigMapper siteConfigMapper;
+    private SiteConfigService siteConfigService;
 
     @GetMapping(value = "/favicon.ico", produces = "image/png")
     public ResponseEntity<ByteArrayResource> getFavicon(HttpServletRequest request) throws IOException {
-        String iconUrl = siteConfigMapper.getSiteIcon();
+        String iconUrl = siteConfigService.getSiteIcon();
         if (iconUrl == null || iconUrl.trim().isEmpty()) {
             return ResponseEntity.notFound().build();
         }

backend/src/main/java/xyz/lingview/dimstack/controller/FileAccessController.java

@@ -14,9 +14,9 @@
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 import xyz.lingview.dimstack.domain.UploadAttachment;
-import xyz.lingview.dimstack.mapper.UploadMapper;
 import xyz.lingview.dimstack.service.ImageCompressionService;
 import xyz.lingview.dimstack.service.SiteConfigService;
+import xyz.lingview.dimstack.service.UploadService;
 
 import java.io.UnsupportedEncodingException;
 import java.net.URLEncoder;
@@ -35,7 +35,7 @@
 public class FileAccessController {
 
     @Autowired
-    private UploadMapper uploadMapper;
+    private UploadService uploadService;
 
     @Autowired
     private ImageCompressionService imageCompressionService;
@@ -62,7 +62,7 @@ public ResponseEntity<Resource> getFile(
         try {
             log.debug("尝试访问文件，访问键: {}, 下载模式: {}", accessKey, download);
 
-            UploadAttachment attachment = uploadMapper.selectByAccessKey(accessKey);
+            UploadAttachment attachment = uploadService.selectByAccessKey(accessKey);
             if (attachment == null) {
                 log.warn("未找到访问键对应的文件: {}", accessKey);
                 return ResponseEntity.notFound().build();
@@ -83,11 +83,11 @@ public ResponseEntity<Resource> getFile(
 
             boolean isImage = contentType.startsWith("image/");
             Resource resource;
-            
+
             if (isImage && !download) {
                 Integer enableCompression = siteConfigService.getEnableImageCompression();
                 boolean shouldCompress = enableCompression != null && enableCompression == 1;
-                
+
                 if (shouldCompress) {
                     Path compressedPath = getCompressedImagePath(filePath);
                     if (Files.exists(compressedPath)) {
@@ -141,14 +141,14 @@ private Path getCompressedImagePath(Path originalPath) {
         Path parentDir = originalPath.getParent();
         String fileName = originalPath.getFileName().toString();
         int dotIndex = fileName.lastIndexOf('.');
-        
+
         String baseName;
         if (dotIndex > 0) {
             baseName = fileName.substring(0, dotIndex);
         } else {
             baseName = fileName;
         }
-        
+
         String compressedFileName = baseName + "_compressed.jpg";
         return parentDir.resolve("compressor").resolve(compressedFileName);
     }

backend/src/main/java/xyz/lingview/dimstack/controller/HomeController.java

@@ -3,6 +3,7 @@
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.*;
+import xyz.lingview.dimstack.common.ApiResponse;
 import xyz.lingview.dimstack.service.ArticleService;
 import xyz.lingview.dimstack.dto.request.PageRequest;
 import xyz.lingview.dimstack.dto.request.PageResult;
@@ -17,17 +18,17 @@ public class HomeController {
     private ArticleService articleService;
 
     @GetMapping("/articles")
-    public PageResult<ArticleDTO> getHomeArticles(PageRequest pageRequest) {
+    public ApiResponse<PageResult<ArticleDTO>> getHomeArticles(PageRequest pageRequest) {
         log.info("接收到获取文章列表请求: page={}, size={}, category={}",
                 pageRequest.getPage(), pageRequest.getSize(), pageRequest.getCategory());
 
         try {
             PageResult<ArticleDTO> result = articleService.getArticlesForHomePage(pageRequest);
             log.info("成功返回文章列表，共{}条记录", result.getTotal());
-            return result;
+            return ApiResponse.success(result);
         } catch (Exception e) {
             log.error("获取文章列表时发生错误", e);
             throw e;
         }
     }
-}
+}

backend/src/main/java/xyz/lingview/dimstack/controller/HotArticleController.java

@@ -1,5 +1,6 @@
 package xyz.lingview.dimstack.controller;
 
+import xyz.lingview.dimstack.common.ApiResponse;
 import xyz.lingview.dimstack.dto.request.HotArticleDTO;
 import xyz.lingview.dimstack.service.HotArticleService;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -16,7 +17,8 @@ public class HotArticleController {
     private HotArticleService hotArticleService;
 
     @GetMapping("/articles")
-    public List<HotArticleDTO> getHotArticles() {
-        return hotArticleService.getHotArticles();
+    public ApiResponse<List<HotArticleDTO>> getHotArticles() {
+        List<HotArticleDTO> articles = hotArticleService.getHotArticles();
+        return ApiResponse.success(articles);
     }
-}
+}