更新API响应结构,添加用户登出和会话删除功能

- 在ApiResponse类中添加conflict方法以处理冲突响应
- 在UserController中实现用户登出功能,返回标准化的API响应
- 在ChatController中实现会话删除功能,返回相应的成功或错误信息
- 更新ErrorCode类,添加CONFLICT错误码以支持新的响应类型
- 修改OpenApiConfig中的API文档标题和描述

此提交增强了用户体验,提供了更清晰的错误处理和API文档。
This commit is contained in:
zyh
2025-07-21 14:07:01 +08:00
parent 8962943123
commit eb5c54e4a7
20 changed files with 1337 additions and 698 deletions

View File

@@ -1,15 +1,21 @@
package com.yundage.chat.controller;
import com.yundage.chat.common.ApiResponse;
import com.yundage.chat.dto.UserDTO;
import com.yundage.chat.dto.UserProfileUpdateRequest;
import com.yundage.chat.entity.User;
import com.yundage.chat.mapper.UserMapper;
import com.yundage.chat.service.UserService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.responses.ApiResponses;
import io.swagger.v3.oas.annotations.security.SecurityRequirement;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.web.bind.annotation.*;
import org.springframework.security.core.Authentication;
import org.springframework.security.core.context.SecurityContextHolder;
import java.time.LocalDateTime;
import java.util.List;
@@ -23,57 +29,120 @@ public class UserController {
@Autowired
private UserMapper userMapper;
@Autowired
private UserService userService;
@GetMapping
@PreAuthorize("hasRole('ADMIN')")
@Operation(summary = "获取所有用户", description = "获取系统中所有用户列表")
@ApiResponse(responseCode = "200", description = "成功获取用户列表")
public List<User> getAllUsers() {
return userMapper.selectAll();
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "200", description = "成功获取用户列表")
public ApiResponse<List<User>> getAllUsers() {
return ApiResponse.success(userMapper.selectAll());
}
@GetMapping("/me")
@Operation(summary = "获取当前用户信息", description = "根据当前用户的token获取用户信息")
@ApiResponses(value = {
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "200", description = "成功获取用户信息"),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "401", description = "未授权")
})
public ApiResponse<UserDTO> getCurrentUser() {
Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
String username = authentication.getName();
User user = userMapper.selectByEmailOrPhone(username);
return ApiResponse.success(UserDTO.fromUser(user));
}
@GetMapping("/{id}")
@PreAuthorize("hasRole('ADMIN')")
@Operation(summary = "根据ID获取用户", description = "根据用户ID获取用户信息")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "成功获取用户信息"),
@ApiResponse(responseCode = "404", description = "用户不存在")
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "200", description = "成功获取用户信息"),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "404", description = "用户不存在")
})
public User getUserById(@Parameter(description = "用户ID") @PathVariable Long id) {
return userMapper.selectOneById(id);
public ApiResponse<User> getUserById(@Parameter(description = "用户ID") @PathVariable Long id) {
User user = userMapper.selectOneById(id);
if (user != null) {
return ApiResponse.success(user);
} else {
return ApiResponse.notFound("用户不存在");
}
}
@PostMapping
@PreAuthorize("hasRole('ADMIN')")
@Operation(summary = "创建用户", description = "创建新的用户")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "用户创建成功"),
@ApiResponse(responseCode = "400", description = "请求参数错误")
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "200", description = "用户创建成功"),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "400", description = "请求参数错误")
})
public User createUser(@RequestBody User user) {
public ApiResponse<User> createUser(@RequestBody User user) {
user.setCreatedAt(LocalDateTime.now());
user.setUpdatedAt(LocalDateTime.now());
userMapper.insert(user);
return user;
return ApiResponse.success(user);
}
@PutMapping("/{id}")
@Operation(summary = "更新用户", description = "更新指定用户的信息")
@PreAuthorize("hasRole('ADMIN')")
@Operation(summary = "更新用户", description = "管理员更新指定用户的信息")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "用户更新成功"),
@ApiResponse(responseCode = "404", description = "用户不存在"),
@ApiResponse(responseCode = "400", description = "请求参数错误")
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "200", description = "用户更新成功"),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "404", description = "用户不存在"),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "400", description = "请求参数错误")
})
public User updateUser(@Parameter(description = "用户ID") @PathVariable Long id, @RequestBody User user) {
public ApiResponse<User> updateUser(@Parameter(description = "用户ID") @PathVariable Long id, @RequestBody User user) {
User existingUser = userMapper.selectOneById(id);
if (existingUser == null) {
return ApiResponse.notFound("用户不存在");
}
user.setId(id);
user.setUpdatedAt(LocalDateTime.now());
userMapper.update(user);
return user;
return ApiResponse.success(user);
}
@PutMapping("/profile")
@Operation(summary = "更新个人资料", description = "普通用户更新自己的个人资料")
@ApiResponses(value = {
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "200", description = "个人资料更新成功"),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "400", description = "请求参数错误"),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "401", description = "未授权"),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "409", description = "邮箱或手机号已被占用")
})
public ApiResponse<UserDTO> updateProfile(@RequestBody UserProfileUpdateRequest request) {
try {
// 获取当前用户
Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
User currentUser = (User) authentication.getPrincipal();
// 调用服务更新用户资料
UserDTO updatedUser = userService.updateCurrentUserProfile(request, currentUser.getId());
return ApiResponse.success(updatedUser);
} catch (RuntimeException e) {
// 处理可能的错误情况
if (e.getMessage().contains("已被其他用户使用")) {
return ApiResponse.conflict(e.getMessage());
} else {
return ApiResponse.badRequest(e.getMessage());
}
}
}
@DeleteMapping("/{id}")
@PreAuthorize("hasRole('ADMIN')")
@Operation(summary = "删除用户", description = "根据ID删除用户")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "用户删除成功"),
@ApiResponse(responseCode = "404", description = "用户不存在")
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "200", description = "用户删除成功"),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "404", description = "用户不存在")
})
public void deleteUser(@Parameter(description = "用户ID") @PathVariable Long id) {
public ApiResponse<Void> deleteUser(@Parameter(description = "用户ID") @PathVariable Long id) {
User existingUser = userMapper.selectOneById(id);
if (existingUser == null) {
return ApiResponse.notFound("用户不存在");
}
userMapper.deleteById(id);
return ApiResponse.success();
}
}