diff --git a/ballcat-admin/ballcat-admin-core/src/main/java/com/hccake/ballcat/admin/modules/sys/controller/AuthController.java b/ballcat-admin/ballcat-admin-core/src/main/java/com/hccake/ballcat/admin/modules/sys/controller/AuthController.java index f4441358..64d36cb9 100644 --- a/ballcat-admin/ballcat-admin-core/src/main/java/com/hccake/ballcat/admin/modules/sys/controller/AuthController.java +++ b/ballcat-admin/ballcat-admin-core/src/main/java/com/hccake/ballcat/admin/modules/sys/controller/AuthController.java @@ -2,7 +2,7 @@ package com.hccake.ballcat.admin.modules.sys.controller; import cn.hutool.core.util.StrUtil; import com.hccake.ballcat.common.core.result.R; -import com.hccake.ballcat.common.core.result.ResultStatus; +import com.hccake.ballcat.common.core.result.SystemResultMsg; import io.swagger.annotations.Api; import lombok.RequiredArgsConstructor; import org.springframework.http.HttpHeaders; @@ -34,13 +34,13 @@ public class AuthController { @DeleteMapping("/logout") public R logout(@RequestHeader(value = HttpHeaders.AUTHORIZATION, required = false) String authHeader) { if (StrUtil.isBlank(authHeader)) { - return R.failed(ResultStatus.FORBIDDEN, "退出失败，token 为空"); + return R.failed(SystemResultMsg.FORBIDDEN, "退出失败，token 为空"); } String tokenValue = authHeader.replace(OAuth2AccessToken.BEARER_TYPE, StrUtil.EMPTY).trim(); OAuth2AccessToken accessToken = tokenStore.readAccessToken(tokenValue); if (accessToken == null || StrUtil.isBlank(accessToken.getValue())) { - return R.failed(ResultStatus.FORBIDDEN,"退出失败，token 无效"); + return R.failed(SystemResultMsg.FORBIDDEN,"退出失败，token 无效"); } diff --git a/ballcat-admin/ballcat-admin-core/src/main/java/com/hccake/ballcat/admin/modules/sys/controller/SysUserController.java b/ballcat-admin/ballcat-admin-core/src/main/java/com/hccake/ballcat/admin/modules/sys/controller/SysUserController.java index 309ab13e..fea8e81a 100644 --- a/ballcat-admin/ballcat-admin-core/src/main/java/com/hccake/ballcat/admin/modules/sys/controller/SysUserController.java +++ b/ballcat-admin/ballcat-admin-core/src/main/java/com/hccake/ballcat/admin/modules/sys/controller/SysUserController.java @@ -13,8 +13,9 @@ import com.hccake.ballcat.admin.modules.sys.model.qo.SysUserQO; import com.hccake.ballcat.admin.modules.sys.service.SysUserRoleService; import com.hccake.ballcat.admin.modules.sys.service.SysUserService; import com.hccake.ballcat.commom.log.operation.annotation.OperationLogging; +import com.hccake.ballcat.common.core.result.BaseResultMsg; import com.hccake.ballcat.common.core.result.R; -import com.hccake.ballcat.common.core.result.ResultStatus; +import com.hccake.ballcat.common.core.result.SystemResultMsg; import com.hccake.ballcat.common.core.vo.SelectData; import io.swagger.annotations.Api; import io.swagger.annotations.ApiOperation; @@ -81,7 +82,7 @@ public class SysUserController { @PreAuthorize("@per.hasPermission('sys:sysuser:add')") public R addSysUser(@Valid @RequestBody SysUserDTO sysUserDto) { return sysUserService.addSysUser(sysUserDto) ? - R.ok() : R.failed(ResultStatus.SAVE_ERROR, "新增系统用户失败"); + R.ok() : R.failed(BaseResultMsg.UPDATE_DATABASE_ERROR, "新增系统用户失败"); } @@ -97,7 +98,7 @@ public class SysUserController { @PreAuthorize("@per.hasPermission('sys:sysuser:edit')") public R updateUserInfo(@Valid @RequestBody SysUserDTO sysUserDto) { return sysUserService.updateSysUser(sysUserDto) ? - R.ok() : R.failed(ResultStatus.SAVE_ERROR, "修改系统用户失败"); + R.ok() : R.failed(BaseResultMsg.UPDATE_DATABASE_ERROR, "修改系统用户失败"); } @@ -113,7 +114,7 @@ public class SysUserController { @PreAuthorize("@per.hasPermission('sys:sysuser:del')") public R deleteByUserId(@PathVariable Integer userId) { return sysUserService.deleteByUserId(userId) ? - R.ok() : R.failed(ResultStatus.SAVE_ERROR, "删除系统用户失败"); + R.ok() : R.failed(BaseResultMsg.UPDATE_DATABASE_ERROR, "删除系统用户失败"); } @@ -156,7 +157,7 @@ public class SysUserController { @PreAuthorize("@per.hasPermission('sys:sysuser:grant')") public R updateUserScope(@PathVariable Integer userId, @RequestBody SysUserScope sysUserScope) { return sysUserService.updateUserScope(userId, sysUserScope) ? - R.ok() : R.failed(ResultStatus.SAVE_ERROR, "系统用户授权失败"); + R.ok() : R.failed(BaseResultMsg.UPDATE_DATABASE_ERROR, "系统用户授权失败"); } @@ -174,11 +175,11 @@ public class SysUserController { @PreAuthorize("@per.hasPermission('sys:sysuser:pass')") public R updateUserPass(@PathVariable Integer userId, String pass, String confirm) { if (StrUtil.isBlank(pass) || StrUtil.isBlank(confirm) || !pass.equals(confirm)) { - return R.failed(ResultStatus.BAD_REQUEST, "错误的密码!"); + return R.failed(SystemResultMsg.BAD_REQUEST, "错误的密码!"); } return sysUserService.updateUserPass(userId, pass) ? - R.ok() : R.failed(ResultStatus.SAVE_ERROR, "修改用户密码失败！"); + R.ok() : R.failed(BaseResultMsg.UPDATE_DATABASE_ERROR, "修改用户密码失败！"); } @@ -199,7 +200,7 @@ public class SysUserController { throw new ValidationException("不支持的用户状态！"); } return sysUserService.updateUserStatus(userIds, status) ? - R.ok() : R.failed(ResultStatus.SAVE_ERROR, "批量修改用户状态！"); + R.ok() : R.failed(BaseResultMsg.UPDATE_DATABASE_ERROR, "批量修改用户状态！"); } @@ -213,7 +214,7 @@ public class SysUserController { objectName = sysUserService.updateAvatar(file, userId); } catch (IOException e) { log.error("修改系统用户头像异常", e); - return R.failed(ResultStatus.FILE_UPLOAD_ERROR); + return R.failed(BaseResultMsg.FILE_UPLOAD_ERROR); } return R.ok(objectName); } diff --git a/ballcat-admin/ballcat-admin-core/src/main/java/com/hccake/ballcat/admin/modules/sys/service/impl/SysPermissionServiceImpl.java b/ballcat-admin/ballcat-admin-core/src/main/java/com/hccake/ballcat/admin/modules/sys/service/impl/SysPermissionServiceImpl.java index 4ee3aab6..2f3d5fff 100644 --- a/ballcat-admin/ballcat-admin-core/src/main/java/com/hccake/ballcat/admin/modules/sys/service/impl/SysPermissionServiceImpl.java +++ b/ballcat-admin/ballcat-admin-core/src/main/java/com/hccake/ballcat/admin/modules/sys/service/impl/SysPermissionServiceImpl.java @@ -10,7 +10,7 @@ import com.hccake.ballcat.admin.modules.sys.model.entity.SysRolePermission; import com.hccake.ballcat.admin.modules.sys.model.vo.PermissionVO; import com.hccake.ballcat.admin.modules.sys.service.SysPermissionService; import com.hccake.ballcat.common.core.exception.BallCatException; -import com.hccake.ballcat.common.core.result.ResultStatus; +import com.hccake.ballcat.common.core.result.BaseResultMsg; import lombok.RequiredArgsConstructor; import org.springframework.stereotype.Service; import org.springframework.transaction.annotation.Transactional; @@ -42,7 +42,7 @@ public class SysPermissionServiceImpl extends ServiceImpl permissionList = this.list(Wrappers.query() .lambda().eq(SysPermission::getParentId, id)); if (CollUtil.isNotEmpty(permissionList)) { - throw new BallCatException(ResultStatus.LOGIC_CHECK_ERROR.getCode(), "菜单含有下级不能删除"); + throw new BallCatException(BaseResultMsg.LOGIC_CHECK_ERROR.getCode(), "菜单含有下级不能删除"); } sysRolePermissionMapper diff --git a/ballcat-admin/ballcat-admin-core/src/main/java/com/hccake/ballcat/admin/oauth/CustomAuthenticationEntryPoint.java b/ballcat-admin/ballcat-admin-core/src/main/java/com/hccake/ballcat/admin/oauth/CustomAuthenticationEntryPoint.java index 0e5e9b7b..3b915641 100644 --- a/ballcat-admin/ballcat-admin-core/src/main/java/com/hccake/ballcat/admin/oauth/CustomAuthenticationEntryPoint.java +++ b/ballcat-admin/ballcat-admin-core/src/main/java/com/hccake/ballcat/admin/oauth/CustomAuthenticationEntryPoint.java @@ -2,7 +2,7 @@ package com.hccake.ballcat.admin.oauth; import com.fasterxml.jackson.databind.ObjectMapper; import com.hccake.ballcat.common.core.result.R; -import com.hccake.ballcat.common.core.result.ResultStatus; +import com.hccake.ballcat.common.core.result.SystemResultMsg; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.HttpStatus; import org.springframework.http.MediaType; @@ -29,7 +29,7 @@ public class CustomAuthenticationEntryPoint implements AuthenticationEntryPoint httpServletResponse.setHeader("Content-Type", MediaType.APPLICATION_JSON.toString()); httpServletResponse.setStatus(HttpStatus.UNAUTHORIZED.value()); httpServletResponse.getWriter().write( - objectMapper.writeValueAsString(R.failed(ResultStatus.UNAUTHORIZED, e.getMessage())) + objectMapper.writeValueAsString(R.failed(SystemResultMsg.UNAUTHORIZED, e.getMessage())) ); } } diff --git a/ballcat-admin/ballcat-admin-core/src/main/java/com/hccake/ballcat/admin/oauth/exception/CustomOAuth2ExceptionSerializer.java b/ballcat-admin/ballcat-admin-core/src/main/java/com/hccake/ballcat/admin/oauth/exception/CustomOAuth2ExceptionSerializer.java index c4e4f32b..0beff8b3 100644 --- a/ballcat-admin/ballcat-admin-core/src/main/java/com/hccake/ballcat/admin/oauth/exception/CustomOAuth2ExceptionSerializer.java +++ b/ballcat-admin/ballcat-admin-core/src/main/java/com/hccake/ballcat/admin/oauth/exception/CustomOAuth2ExceptionSerializer.java @@ -4,7 +4,7 @@ import com.fasterxml.jackson.core.JsonGenerator; import com.fasterxml.jackson.databind.SerializerProvider; import com.fasterxml.jackson.databind.ser.std.StdSerializer; import com.hccake.ballcat.common.core.result.R; -import com.hccake.ballcat.common.core.result.ResultStatus; +import com.hccake.ballcat.common.core.result.SystemResultMsg; import java.io.IOException; @@ -21,6 +21,6 @@ public class CustomOAuth2ExceptionSerializer extends StdSerializer implements Serializable { } public static R ok(T data) { - return new R().setCode(ResultStatus.OK.getCode()) + return new R().setCode(SystemResultMsg.SUCCESS.getCode()) .setData(data) - .setMsg(ResultStatus.OK.getMessage()); + .setMsg(SystemResultMsg.SUCCESS.getMessage()); } - public static R failed(ResultStatus failStatus) { - return new R().setCode(failStatus.getCode()) - .setMsg(failStatus.getMessage()); + public static R failed(ResultMsg failMsg) { + return new R().setCode(failMsg.getCode()) + .setMsg(failMsg.getMessage()); } - public static R failed(ResultStatus failStatus, String msg) { - return new R().setCode(failStatus.getCode()) + public static R failed(ResultMsg failMsg, String msg) { + return new R().setCode(failMsg.getCode()) .setMsg(msg); } diff --git a/ballcat-common/ballcat-common-core/src/main/java/com/hccake/ballcat/common/core/result/ResultMsg.java b/ballcat-common/ballcat-common-core/src/main/java/com/hccake/ballcat/common/core/result/ResultMsg.java new file mode 100644 index 00000000..08391ab7 --- /dev/null +++ b/ballcat-common/ballcat-common-core/src/main/java/com/hccake/ballcat/common/core/result/ResultMsg.java @@ -0,0 +1,21 @@ +package com.hccake.ballcat.common.core.result; + +/** + * @author Hccake + * @version 1.0 + * @date 2020/3/20 14:45 + */ +public interface ResultMsg { + + /** + * 获取业务码 + * @return 业务码 + */ + Integer getCode(); + + /** + * 获取信息 + * @return 返回结构体中的信息 + */ + String getMessage(); +} diff --git a/ballcat-common/ballcat-common-core/src/main/java/com/hccake/ballcat/common/core/result/ResultStatus.java b/ballcat-common/ballcat-common-core/src/main/java/com/hccake/ballcat/common/core/result/ResultStatus.java deleted file mode 100644 index 49f56bff..00000000 --- a/ballcat-common/ballcat-common-core/src/main/java/com/hccake/ballcat/common/core/result/ResultStatus.java +++ /dev/null @@ -1,76 +0,0 @@ -package com.hccake.ballcat.common.core.result; - -import lombok.AllArgsConstructor; -import lombok.Getter; - -/** - * @author Hccake - * @version 1.0 - * @date 2019/9/12 12:19 - */ -@Getter -@AllArgsConstructor -public enum ResultStatus { - - // ================ 基础部分，参考 HttpStatus ============= - - /** - * 成功 - */ - OK(200,"Success"), - /** - * 参数错误 - */ - BAD_REQUEST(400, "Bad Request"), - /** - * 未认证 - */ - UNAUTHORIZED(401, "Unauthorized"), - /** - * 未授权 - */ - FORBIDDEN(403, "Forbidden"), - /** - * 服务异常 - */ - SERVER_ERROR(500, "Internal Server Error"), - - - /** - * ===========项目部分，业务错误码开始=================== - * TODO 设计 - * 业务错误码规范： - * - * - */ - - /** - * 保存失败 - */ - SAVE_ERROR(90000, "Insert Or Update Data Failed"), - - /** - * 通用的逻辑校验异常 - */ - LOGIC_CHECK_ERROR(90001, "Logic Check Error"), - - /** - * 恶意请求 - */ - MALICIOUS_REQUEST(90002, "Malicious Request"), - - /** - * 文件上传异常 - */ - FILE_UPLOAD_ERROR(90003, "File Upload Error"), - - /** - * 未知异常 - */ - UNKNOWN_ERROR(99999, "Unknown Error"); - - - - private Integer code; - private String message; -} diff --git a/ballcat-common/ballcat-common-core/src/main/java/com/hccake/ballcat/common/core/result/SystemResultMsg.java b/ballcat-common/ballcat-common-core/src/main/java/com/hccake/ballcat/common/core/result/SystemResultMsg.java new file mode 100644 index 00000000..fd3c8ae4 --- /dev/null +++ b/ballcat-common/ballcat-common-core/src/main/java/com/hccake/ballcat/common/core/result/SystemResultMsg.java @@ -0,0 +1,40 @@ +package com.hccake.ballcat.common.core.result; + +import lombok.AllArgsConstructor; +import lombok.Getter; + +/** + * @author Hccake + * @version 1.0 + * @date 2019/9/12 12:19 + */ +@Getter +@AllArgsConstructor +public enum SystemResultMsg implements ResultMsg{ + + // ================ 基础部分，参考 HttpStatus ============= + /** + * 成功 + */ + SUCCESS(200,"Success"), + /** + * 参数错误 + */ + BAD_REQUEST(400, "Bad Request"), + /** + * 未认证 + */ + UNAUTHORIZED(401, "Unauthorized"), + /** + * 未授权 + */ + FORBIDDEN(403, "Forbidden"), + /** + * 服务异常 + */ + SERVER_ERROR(500, "Internal Server Error"); + + + private Integer code; + private String message; +}