devbox
小蓝xlanll
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

SpringBoot统一返回结果，统一异常处理，统一header参数校验等通用操作_springboot@header

作者：小蓝xlanll | 2024-03-03 06:56:09

赞

踩

springboot@header

spring-base Gitee地址


对springBoot项目的一些通用操作进行的封装,包括如下几个部分：

  • 统一的异常捕获
  • 统一的JSON返回格式
  • 统一的权限接口扫描：@Privilege 被注解的请求会在项目启动时被扫描处理,此注解需要配合@HeaderChecker使用
  • 统一的请求header参数校验与权限校验：@HeaderChecker 被注解的请求会被拦截到HeaderPropertyChecker处理
  • 这个基础模块在构建SpringBoot项目时给我带来了很大的方便，添加依赖就可以轻松构建标准的SpringBoot项目

使用方法

  1. 首先在 Gitee地址下载源代码使用maven将本项目maven install 安装到本地仓库，安装前可修改springBoot(2.3.10.RELEASE)以及springCloud(Hoxton.SR11)版本，若不使用微服务也可以把springCloud删除。

  2. 创建新的maven项目，并在pom.xml中设置父项目和基础依赖

    <!--设置父项目为本项目-->
<parent>
    <groupId>gaozhi.online</groupId>
    <artifactId>spring-base</artifactId>
    <version>1.0</version>
 </parent>

<!--添加基础依赖-->
<dependencys>
    <dependency>
        <groupId>gaozhi.online</groupId>
         <artifactId>base</artifactId>
         <version>1.0</version>
    </dependency>
</dependencys>

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15

简单应用到项目

  1. 统一结果格式：在新项目的Application中添加包扫描配置即可自动将Controller层返回结果封装为JSON

    @SpringBootApplication
//添加基础包（gaozhi.online.base.ScanClass.class）的扫描；可以添加自身项目的扫描路径
@ComponentScan(basePackageClasses = {gaozhi.online.base.ScanClass.class,Application.class})
public class Application {
   public static void main(String[] args) {
       SpringApplication.run(Application.class);
   }
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8

    统一返回结果格式如下：

    //格式
{
    "code": 200(返回码),
    "message": "请求成功"（提示信息）,
    "data": "{\"id\":2147483648}" （返回对象的json串）
}
//实例
{
  "code": 200,
  "message": "请求成功",
  "data": "{\"id\":2147483648,\"headUrl\":\"https://gimg2.baidu.com/image_search/src\\u003dhttp%3A%2F%2Fc-ssl.duitang.com%2Fuploads%2Fblog%2F202107%2F17%2F20210717232533_2edcf.thumb.1000_0.jpg\\u0026refer\\u003dhttp%3A%2F%2Fc-ssl.duitang.com\\u0026app\\u003d2002\\u0026size\\u003df9999,10000\\u0026q\\u003da80\\u0026n\\u003d0\\u0026g\\u003d0n\\u0026fmt\\u003dauto?sec\\u003d1651719991\\u0026t\\u003d7765c89c73904f25968e23b718075a8b\",\"nick\":\"张三2\",\"remark\":\"快乐p2p\",\"gender\":\"male\",\"birth\":0,\"email\":\"lfc_guest@163.com\",\"createTime\":1634974238958,\"updateTime\":1649048839660,\"banTime\":0,\"status\":1,\"vip\":0}"
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12

  2. 统一异常处理：在接口逻辑任意地方抛出的运行时异常都将被捕获并封装为JSON格式，推荐实现BusinessRuntimeException接口编写自定义异常并枚举异常类型。

    • 自定义异常：
    /**
* 自定义异常
*/
public class UserException extends BusinessRuntimeException {

    public UserException(Result.ResultEnum exception) {
        super(exception);
    }

    public UserException(Result.ResultEnum exception, String msg) {
        super(exception, msg);
    }
}
/**
* 枚举异常值
*/
public enum UserExceptionEnum implements Result.ResultEnum {
    USER_AUTH_ERROR(2000,"API请求权限校验失败:请重新登陆，您的账号有被盗用的风险，请及时修改密码"),
    USER_PASS_ERROR(2001,"密码错误"),
    USER_ACCOUNT_FORBIDDEN(2002,"账号已被禁用"),
    USER_ACCOUNT_CANCEL(2003,"账号已注销"),
    USER_NOT_EXIST(2004,"用户不存在");
    private final int  code;
    private final String message;

    UserExceptionEnum(int code, String message) {
        this.code = code;
        this.message = message;
    }

    @Override
    public int code() {
        return code;
    }

    @Override
    public String message() {
        return message;
    }
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 抛出异常：
       userInfo = userService.findUserInfo(userId);
   if (userInfo == null) {
      //推荐实现
      throw new UserException(UserExceptionEnum.USER_NOT_EXIST,"其余附加信息");
   }

    • 1
    • 2
    • 3
    • 4
    • 5

  3. 统一header校验：被@HeaderChecker注解的方法将会被拦截经过自定义的参数校验逻辑，并自动在请求属性中注入客户端远程ip和接口路径信息

    • 自定义校验逻辑（示例）
    import com.google.gson.Gson;
import gaozhi.online.base.exception.BusinessRuntimeException;
import gaozhi.online.base.interceptor.HeaderChecker;
import gaozhi.online.base.interceptor.HeaderPropertyChecker;
import gaozhi.online.peoplety.entity.Token;
import gaozhi.online.peoplety.entity.UserInfo;
import gaozhi.online.peoplety.exception.UserException;
import gaozhi.online.peoplety.exception.enums.UserExceptionEnum;
import gaozhi.online.peoplety.user.service.UserService;
import gaozhi.online.peoplety.util.DateTimeUtil;
import org.apache.commons.logging.Log;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.log.LogDelegateFactory;
import org.springframework.stereotype.Component;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;


/**
* 检查token
*/
@Component(HeaderChecker.accessToken)
public class TokenChecker implements HeaderPropertyChecker<Token> {
   public static final String HEADER_ATTRIBUTE_USER = "user";
   private final Log log = LogDelegateFactory.getHiddenLog(TokenChecker.class);
   private final Gson gson = new Gson();
   @Autowired
   private UserService userService;
   /**被HeaderChecker注释的接口会走如下逻辑进行header参数校验，一般为Token检查用户是否登陆*/
   @Override
   public Token check(String value, String url, String ip,HttpServletRequest request,HttpServletResponse response) {
       //log.info("url=" + url + " 检查用户token:" + value);
       Token token = gson.fromJson(value, Token.class);
       if (token == null) {
           throw new BusinessRuntimeException(UserExceptionEnum.USER_AUTH_ERROR);
       }
       UserInfo userInfo = userService.findUserInfo(token.getUserid());
       if (userInfo == null) {
           throw new UserException(UserExceptionEnum.USER_NOT_EXIST);
       }
       //校验token
       if (!userService.checkToken(token)) {
           //失败返回上次登陆ip
           throw new UserException(UserExceptionEnum.USER_AUTH_ERROR, userInfo.getIp());
       }

       //更新ip地址
       userInfo.setIp(ip);
       userService.updateIp(token.getUserid(), ip);
       //检查账号是否被封禁
       if (userInfo.getBanTime() > System.currentTimeMillis()) {
           throw new UserException(UserExceptionEnum.USER_ACCOUNT_FORBIDDEN, "如有疑问请进行申诉，解封时间为" + DateTimeUtil.getDefaultFormatTime(userInfo.getBanTime()));
       }
       //校验url权限
       if (!userService.checkURLPrivilege(userInfo.getStatus(), url)) {
           throw new UserException(UserExceptionEnum.USER_AUTH_ERROR, "没有权限访问 url=" + url);
       }

       request.setAttribute(HEADER_ATTRIBUTE_USER, userInfo);
       return token;
   }
    /**被HeaderChecker注释且被Privilege注释的接口会走如下逻辑进行权限校验*/
   @Override
   public void privilegeCheck(String url, String clientIp, HttpServletRequest request) {
       UserInfo userInfo = (UserInfo) request.getAttribute(HEADER_ATTRIBUTE_USER);
       //校验url权限
       log.info(url);
       if (!userService.checkURLPrivilege(userInfo.getStatus(), url)) {
           throw new UserException(UserExceptionEnum.USER_AUTH_ERROR, "没有权限访问 url=" + url);
       }
       //把所有需要鉴权的地方加上Privilege注解，添加角色与权限之间的关系
       //更新ip地址
       userInfo.setIp(clientIp);
       userService.updateIp(userInfo.getId(), clientIp);
       //记录日志
       log.info("发生敏感操作，此处需要记录日志，url:{} , clientIp:{}",url,clientIp);
       SysLog sysLog = new SysLog();
       sysLog.setIp(clientIp);
       sysLog.setTime(System.currentTimeMillis());
       sysLog.setUserid(userInfo.getId());
       sysLog.setUrl(url);
       sysLogFeignClient.postLog(sysLog);
   }
}


    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    • 46
    • 47
    • 48
    • 49
    • 50
    • 51
    • 52
    • 53
    • 54
    • 55
    • 56
    • 57
    • 58
    • 59
    • 60
    • 61
    • 62
    • 63
    • 64
    • 65
    • 66
    • 67
    • 68
    • 69
    • 70
    • 71
    • 72
    • 73
    • 74
    • 75
    • 76
    • 77
    • 78
    • 79
    • 80
    • 81
    • 82
    • 83
    • 84
    • 85
    • 获取自动注入的属性（可通过参数注解方式）
      //客户端调用的接口url，如果经过微服务转发值为客户端调用的接口，可以用于鉴权
  request.getAttribute(HeaderChecker.rpcURLKey);
  //客户端IP
  request.getAttribute(HeaderChecker.rpcClientIp);

  //参数注解方式获取
  @RequestAttribute(HeaderChecker.rpcClientIp) String clientIp

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7

  4. 权限列表的扫描，会在项目启动时扫描一次被@Privilege注解的接口，可以动态的更新权限的列表

    • 添加注解
    /**对类添加@Privilege注解，标识此类中有需要扫描的方法*/

@Privilege(name = "角色管理",description = "对角色进行管理")
@Validated
@RestController
@RequestMapping(value = "/admin/role")
@Slf4j
public class AdminRoleController {
   @Privilege(name = "修改角色",description = "修改角色的具体信息")
   @HeaderChecker
   @PostMapping(value = "/post/operate")
   public Role operateRole(@RequestAttribute(TokenChecker.HEADER_ATTRIBUTE_USER) UserInfo loginUser, @RequestBody Role role){
        
   }
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 实现接口 PrivilegeHandler 示例如下
     /**
 * @description: TODO  启动时扫描需要鉴权的API
 * @author http://gaozhi.online
 * @date 2022/11/21 21:57
 * @version 1.0
 */
 @Component
 @Slf4j
 public class PrivilegeScanService implements PrivilegesInitializer {
     private PrivilegeHandler privilegeHandler;
 
     public void setPrivilegeHandler(PrivilegeHandler privilegeHandler) {
         this.privilegeHandler = privilegeHandler;
     }
 
     @Override
     public void handlePrivilege(Privilege klass, Privilege method, String[] fullUrl, String[] methodUrl) {
         log.info("扫描到需要鉴权的接口：{}-{}-{}-{}",klass.name(),method.name(),Arrays.toString(fullUrl), Arrays.toString(methodUrl));
         for(String kUrl:fullUrl){
             for(String mUrl:methodUrl){
                 if(kUrl.endsWith(mUrl)){
                     //找到对应的方法
                     log.info("找到路径匹配的方法:类URL：{},方法URL:{}",kUrl,mUrl);
                     gaozhi.online.peoplety.entity.Privilege klassPrivilege = new gaozhi.online.peoplety.entity.Privilege();
                     //一级权限
                     klassPrivilege.setFirstUrl(kUrl.substring(0,kUrl.length() - mUrl.length()));
                     klassPrivilege.setSubUrl("*");
                     klassPrivilege.setUrl(klassPrivilege.getFirstUrl()+klassPrivilege.getSubUrl());
                     klassPrivilege.setName(klass.name());
                     klassPrivilege.setDescription(klass.description());
                     insertOrUpdate(klassPrivilege);
                     //二级权限
                     gaozhi.online.peoplety.entity.Privilege privilege = new gaozhi.online.peoplety.entity.Privilege();
                     privilege.setUrl(kUrl);
                     privilege.setFirstUrl(klassPrivilege.getFirstUrl());
                     privilege.setSubUrl(mUrl);
                     privilege.setName(method.name());
                     privilege.setDescription(method.description());
                     insertOrUpdate(privilege);
                     break;
                 }
             }
         }
     }
     private void insertOrUpdate(gaozhi.online.peoplety.entity.Privilege privilege){
         if(privilegeHandler!=null){
             privilegeHandler.handle(privilege);
         }else{
             log.info("未注入权限处理器 PrivilegeHandler: 权限未处理:{}", privilege);
         }
     }
     /**权限处理者，可以实现插入数据库等操作*/
     public interface PrivilegeHandler{
         void handle(gaozhi.online.peoplety.entity.Privilege privilege);
     }
 }

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    • 46
    • 47
    • 48
    • 49
    • 50
    • 51
    • 52
    • 53
    • 54
    • 55
    • 56
声明：本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：【wpsshop博客】
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号