• Springboot 之整合(全局异常、响应式封装类、JSR303验证、自定义注解)效验登录状态

    目录

    1. springboot 整合全局异常、响应式封装类效验登录状态

     1.1 在pom.xml文件添加以下相关依赖

     1.2 model模块代码

     1.3 utils模块

     1.4 exception模块

     1.5 controller模块

    2. springboot 整合全局异常 + 响应式封装类 + JSR303后端验证 + 自定义注解 效验登录状态

    2.1 添加pom.xml 相关依赖

    2.2 utils模块

    2.3  annotation模块

    2.4 validation模块

    2.5 model模块

    2.6 exception模块 

    2.7 controller模块

    前言

     第一种方式采用springboot 整合全局异常 + 响应式封装类进行效验登录状态

     第二种方式通过springboot 整合全局异常 + 响应式封装类 + JSR303后端验证 + 自定义注解效验     登录状态

    1. springboot 整合全局异常、响应式封装类效验登录状态

      1.1 在pom.xml文件添加以下相关依赖

    1.   <dependency>
    2.             <groupId>org.springframework.bootgroupId>
    3.             <artifactId>spring-boot-starter-freemarkerartifactId>
    4.         dependency>
    5.         <dependency>
    6.             <groupId>org.springframework.bootgroupId>
    7.             <artifactId>spring-boot-starter-jdbcartifactId>
    8.         dependency>
    9.         <dependency>
    10.             <groupId>org.springframework.bootgroupId>
    11.             <artifactId>spring-boot-starter-webartifactId>
    12.         dependency>
    13.         <dependency>
    14.             <groupId>org.mybatis.spring.bootgroupId>
    15.             <artifactId>mybatis-spring-boot-starterartifactId>
    16.             <version>2.2.2version>
    17.         dependency>
    18.  
    19.         <dependency>
    20.             <groupId>mysqlgroupId>
    21.             <artifactId>mysql-connector-javaartifactId>
    22.             <scope>runtimescope>
    23.             <version>5.1.44version>
    24.         dependency>
    25.         <dependency>
    26.             <groupId>org.projectlombokgroupId>
    27.             <artifactId>lombokartifactId>
    28.             <optional>trueoptional>
    29.         dependency>
    30.         
    31.         <dependency>
    32.             <groupId>org.apache.commonsgroupId>
    33.             <artifactId>commons-lang3artifactId>
    34.             <version>3.12.0version>
    35.         dependency>
    36.         
    37.         <dependency>
    38.             <groupId>org.springframework.bootgroupId>
    39.             <artifactId>spring-boot-starter-validationartifactId>
    40.             <version>2.7.4version>
    41.         dependency>

       1.2 model模块代码

          User 

    1. package com.jmh.springboot03.model;
    2.  
    3. import com.jmh.springboot03.annotation.IsUserName;
    4. import lombok.Data;
    5.  
    6. import javax.validation.constraints.NotBlank;
    7.  
    8. /**
    9.  * @author 蒋明辉
    10.  * @data 2022/9/29 17:09
    11.  */
    12. @Data
    13. public class User {
    14.     //手机号码
    15.     private String username;
    16.     //密码
    17.     private String password;
    18. }

      1.3 utils模块

        JsonResponseStatus 这是个枚举类

    1. package com.jmh.springboot03.utils;
    2.  
    3. import lombok.AllArgsConstructor;
    4. import lombok.Getter;
    5. import lombok.NoArgsConstructor;
    6.  
    7. /**
    8.  * @author 蒋明辉
    9.  * @data 2022/9/26 17:36
    10.  */
    11. @Getter
    12. @NoArgsConstructor
    13. @AllArgsConstructor
    14. public enum JsonResponseStatus {
    15.  
    16.     success(200,"ok"),
    17.     error(500,"内部异常"),
    18.     operation_success(2000,"操作成功"),
    19.     operation_failed(5000,"操作失败"),
    20.     name_empty(20000,"手机号码不能为空"),
    21.     pwd_empty(50000,"密码不能为空"),
    22.     name_pwd_empty(251,"手机号或者密码为空"),
    23.     name_error(20001,"手机号码格式错误")
    24.     ;
    25.  
    26.     //响应代码
    27.     private int code;
    28.     //响应信息
    29.     private String msg;
    30. }

       JsonResponseBody 这是个泛型类

    1. package com.jmh.springboot03.utils;
    2.  
    3. import lombok.Data;
    4.  
    5. /**
    6.  * @author 蒋明辉
    7.  * @data 2022/9/26 17:38
    8.  */
    9. @Data
    10. public class JsonResponseBody {
    11.  
    12.     //响应代码
    13.     private int code;
    14.     //响应信息
    15.     private String msg;
    16.     //响应数据
    17.     private T data;
    18.     //响应总记录数
    19.     private int total=0;
    20.  
    21.     public JsonResponseBody(){
    22.         this.code= JsonResponseStatus.success.getCode();
    23.         this.msg=JsonResponseStatus.success.getMsg();
    24.     }
    25.  
    26.     public JsonResponseBody(JsonResponseStatus jsonResponseStatus){
    27.         this.code=jsonResponseStatus.getCode();
    28.         this.msg=jsonResponseStatus.getMsg();
    29.     }
    30.  
    31.     public JsonResponseBody(T data){
    32.         this.data=data;
    33.         this.code=JsonResponseStatus.success.getCode();
    34.         this.msg=JsonResponseStatus.success.getMsg();
    35.     }
    36.  
    37.     public JsonResponseBody(T data,int total){
    38.         this.data=data;
    39.         this.total=total;
    40.         this.code=JsonResponseStatus.success.getCode();
    41.         this.msg=JsonResponseStatus.success.getMsg();
    42.     }
    43.  
    44. }

       ValidatorUtils 验证手机号码格式的工具类

    1. package com.jmh.springboot03.utils;
    2.  
    3. import org.apache.commons.lang3.StringUtils;
    4.  
    5. import java.util.regex.Matcher;
    6. import java.util.regex.Pattern;
    7.  
    8. /**
    9.  * 正则校验工具类
    10.  * @author 刘开宇
    11.  */
    12. public class ValidatorUtils {
    13.  
    14.     private static final Pattern mobile_pattern=Pattern.compile("[1]([0-9])[0-9]{9}$");
    15.  
    16.     public static boolean isMobile(String mobile){
    17.         if(StringUtils.isEmpty(mobile))
    18.             return false;
    19.         Matcher matcher = mobile_pattern.matcher(mobile);
    20.         return matcher.matches();
    21.     }
    22. }

      1.4 exception模块

        BusinessException

    1. package com.jmh.springboot03.exception;
    2.  
    3. import com.jmh.springboot03.utils.JsonResponseBody;
    4. import com.jmh.springboot03.utils.JsonResponseStatus;
    5. import lombok.AllArgsConstructor;
    6. import lombok.Data;
    7. import lombok.NoArgsConstructor;
    8.  
    9. /**
    10.  * @author 蒋明辉
    11.  * @data 2022/9/29 18:24
    12.  */
    13. @Data
    14. @AllArgsConstructor
    15. @NoArgsConstructor
    16. public class BusinessException extends RuntimeException{
    17.     private JsonResponseStatus jsonResponseStatus;
    18.  
    19. }

       GlobalExceptionHandler

    1. package com.jmh.springboot03.exception;
    2.  
    3. import com.jmh.springboot03.utils.JsonResponseBody;
    4. import com.jmh.springboot03.utils.JsonResponseStatus;
    5. import org.springframework.validation.BindException;
    6. import org.springframework.web.bind.annotation.ExceptionHandler;
    7. import org.springframework.web.bind.annotation.RestControllerAdvice;
    8.  
    9. /**
    10.  * @author 蒋明辉
    11.  * @data 2022/9/29 18:26
    12.  */
    13. @RestControllerAdvice
    14. public class GlobalExceptionHandler {
    15.  
    16.     @ExceptionHandler
    17.     public JsonResponseBody exceptionHandler(Exception e){
    18.         //e.printStackTrace();//打印异常信息
    19.         //定义一个jsonResponseBody
    20.         JsonResponseBody jsonResponseBody=null;
    21.         if(e instanceof BusinessException) {//是否是BusinessException异常
    22.             //强转为BusinessException
    23.             BusinessException businessException = (BusinessException) e;
    24.             //实例化jsonResponseBody
    25.             jsonResponseBody = new JsonResponseBody<>(businessException.getJsonResponseStatus());
    26.         }else {
    27.             jsonResponseBody=new JsonResponseBody<>(JsonResponseStatus.error);
    28.         }
    29.         return jsonResponseBody;
    30.     }
    31.  
    32. }

     1.5 controller模块

       LoginController

    1. package com.jmh.springboot03.controller;
    2.  
    3. import com.jmh.springboot03.exception.BusinessException;
    4. import com.jmh.springboot03.model.User;
    5. import com.jmh.springboot03.utils.JsonResponseBody;
    6. import com.jmh.springboot03.utils.JsonResponseStatus;
    7. import com.jmh.springboot03.utils.ValidatorUtils;
    8. import org.apache.commons.lang3.StringUtils;
    9. import org.springframework.stereotype.Controller;
    10. import org.springframework.validation.annotation.Validated;
    11. import org.springframework.web.bind.annotation.RequestMapping;
    12. import org.springframework.web.bind.annotation.RestController;
    13.  
    14. /**
    15.  * @author 蒋明辉
    16.  * @data 2022/9/29 17:06
    17.  */
    18. @RestController
    19. @RequestMapping("/user")
    20. public class LoginController {
    21.  
    22.     @RequestMapping("/toLogin")
    23.     public JsonResponseBody toLogin(User user){
    24.         //1.判断手机号或者密码不能为空
    25.         if(StringUtils.isEmpty(user.getUsername())||StringUtils.isEmpty(user.getPassword())){
    26.             //抛给全局异常处理
    27.             throw new BusinessException(JsonResponseStatus.name_pwd_empty);
    28.         }
    29.         //2.判断手机格式
    30.         if(!ValidatorUtils.isMobile(user.getUsername())){
    31.             //抛给全局异常处理
    32.             throw new BusinessException(JsonResponseStatus.name_error);
    33.         }
    34.         return new JsonResponseBody<>();
    35.     }
    36.  
    37. }
    38.  
    39.  
    40.  
    41.  
    42.  
    43.  
    44.  
    45.  
    46.

    2. springboot 整合全局异常 + 响应式封装类 + JSR303后端验证 + 自定义注解 效验登录状态

      2.1 添加pom.xml 相关依赖

    1.   <dependency>
    2.             <groupId>org.springframework.bootgroupId>
    3.             <artifactId>spring-boot-starter-freemarkerartifactId>
    4.         dependency>
    5.         <dependency>
    6.             <groupId>org.springframework.bootgroupId>
    7.             <artifactId>spring-boot-starter-jdbcartifactId>
    8.         dependency>
    9.         <dependency>
    10.             <groupId>org.springframework.bootgroupId>
    11.             <artifactId>spring-boot-starter-webartifactId>
    12.         dependency>
    13.         <dependency>
    14.             <groupId>org.mybatis.spring.bootgroupId>
    15.             <artifactId>mybatis-spring-boot-starterartifactId>
    16.             <version>2.2.2version>
    17.         dependency>
    18.  
    19.         <dependency>
    20.             <groupId>mysqlgroupId>
    21.             <artifactId>mysql-connector-javaartifactId>
    22.             <scope>runtimescope>
    23.             <version>5.1.44version>
    24.         dependency>
    25.         <dependency>
    26.             <groupId>org.projectlombokgroupId>
    27.             <artifactId>lombokartifactId>
    28.             <optional>trueoptional>
    29.         dependency>
    30.         
    31.         <dependency>
    32.             <groupId>org.apache.commonsgroupId>
    33.             <artifactId>commons-lang3artifactId>
    34.             <version>3.12.0version>
    35.         dependency>
    36.         
    37.         <dependency>
    38.             <groupId>org.springframework.bootgroupId>
    39.             <artifactId>spring-boot-starter-validationartifactId>
    40.             <version>2.7.4version>
    41.         dependency>

      2.2 utils模块

       JsonResponseStastus 这是一个枚举类

    1. package com.jmh.springboot03.utils;
    2.  
    3. import lombok.AllArgsConstructor;
    4. import lombok.Getter;
    5. import lombok.NoArgsConstructor;
    6.  
    7. /**
    8.  * @author 蒋明辉
    9.  * @data 2022/9/26 17:36
    10.  */
    11. @Getter
    12. @NoArgsConstructor
    13. @AllArgsConstructor
    14. public enum JsonResponseStatus {
    15.  
    16.     success(200,"ok"),
    17.     error(500,"内部异常"),
    18.     operation_success(2000,"操作成功"),
    19.     operation_failed(5000,"操作失败"),
    20.     name_empty(20000,"手机号码不能为空"),
    21.     pwd_empty(50000,"密码不能为空"),
    22.     name_pwd_empty(251,"手机号或者密码为空"),
    23.     name_error(20001,"手机号码格式错误")
    24.     ;
    25.  
    26.     //响应代码
    27.     private int code;
    28.     //响应信息
    29.     private String msg;
    30. }

       JsonResponseBody 这是一个泛型类

    1. package com.jmh.springboot03.utils;
    2.  
    3. import lombok.Data;
    4.  
    5. /**
    6.  * @author 蒋明辉
    7.  * @data 2022/9/26 17:38
    8.  */
    9. @Data
    10. public class JsonResponseBody {
    11.  
    12.     //响应代码
    13.     private int code;
    14.     //响应信息
    15.     private String msg;
    16.     //响应数据
    17.     private T data;
    18.     //响应总记录数
    19.     private int total=0;
    20.  
    21.     public JsonResponseBody(){
    22.         this.code= JsonResponseStatus.success.getCode();
    23.         this.msg=JsonResponseStatus.success.getMsg();
    24.     }
    25.  
    26.     public JsonResponseBody(JsonResponseStatus jsonResponseStatus){
    27.         this.code=jsonResponseStatus.getCode();
    28.         this.msg=jsonResponseStatus.getMsg();
    29.     }
    30.  
    31.     public JsonResponseBody(T data){
    32.         this.data=data;
    33.         this.code=JsonResponseStatus.success.getCode();
    34.         this.msg=JsonResponseStatus.success.getMsg();
    35.     }
    36.  
    37.     public JsonResponseBody(T data,int total){
    38.         this.data=data;
    39.         this.total=total;
    40.         this.code=JsonResponseStatus.success.getCode();
    41.         this.msg=JsonResponseStatus.success.getMsg();
    42.     }
    43.  
    44. }

       ValidatorUtils 这是一个效验手机号码格式的工具类

    1. package com.jmh.springboot03.utils;
    2.  
    3. import org.apache.commons.lang3.StringUtils;
    4.  
    5. import java.util.regex.Matcher;
    6. import java.util.regex.Pattern;
    7.  
    8. /**
    9.  * 正则校验工具类
    10.  * @author 刘开宇
    11.  */
    12. public class ValidatorUtils {
    13.  
    14.     private static final Pattern mobile_pattern=Pattern.compile("[1]([0-9])[0-9]{9}$");
    15.  
    16.     public static boolean isMobile(String mobile){
    17.         if(StringUtils.isEmpty(mobile))
    18.             return false;
    19.         Matcher matcher = mobile_pattern.matcher(mobile);
    20.         return matcher.matches();
    21.     }
    22. }

     2.3  annotation模块

        IsUserName 这是一个注解类

    1. package com.jmh.springboot03.annotation;
    2.  
    3. import com.jmh.springboot03.validation.UserNameValidation;
    4.  
    5. import javax.validation.Constraint;
    6. import javax.validation.Payload;
    7. import java.lang.annotation.*;
    8.  
    9. /**
    10.  * @author 蒋明辉
    11.  * @data 2022/9/29 19:02
    12.  */
    13. @Documented
    14. @Constraint(
    15.         validatedBy = {UserNameValidation.class}
    16. )
    17. @Target({ElementType.FIELD})
    18. @Retention(RetentionPolicy.RUNTIME)
    19. public @interface IsUserName {
    20.     boolean require() default true;
    21.  
    22.     String message() default "手机号码格式错误";
    23.  
    24.     Class[] groups() default {};
    25.  
    26.     Classextends Payload>[] payload() default {};
    27. }

    2.4 validation模块

       UserNameValidation

    1. package com.jmh.springboot03.validation;
    2.  
    3. import com.jmh.springboot03.annotation.IsUserName;
    4. import com.jmh.springboot03.utils.ValidatorUtils;
    5. import org.springframework.validation.annotation.Validated;
    6.  
    7. import javax.validation.ConstraintValidator;
    8. import javax.validation.ConstraintValidatorContext;
    9.  
    10. /**
    11.  * @author 蒋明辉
    12.  * @data 2022/9/29 19:19
    13.  */
    14. public class UserNameValidation implements ConstraintValidator {
    15.  
    16.     private boolean required=true;
    17.  
    18.     @Override
    19.     public void initialize(IsUserName constraintAnnotation) {
    20.         //将IsUserName注解的值赋值给required
    21.         this.required=constraintAnnotation.require();
    22.  
    23.     }
    24.  
    25.     @Override
    26.     public boolean isValid(String username, ConstraintValidatorContext constraintValidatorContext) {
    27.         //如果required是等于false的就代码不需要验证就进行下一步操作
    28.         if (!required){//取反
    29.             return true;//true就继续验证下一步 false代码不继续下面操作
    30.         }
    31.         return ValidatorUtils.isMobile(username);
    32.     }
    33. }

    2.5 model模块

       User 

    1. package com.jmh.springboot03.model;
    2.  
    3. import com.jmh.springboot03.annotation.IsUserName;
    4. import lombok.Data;
    5.  
    6. import javax.validation.constraints.NotBlank;
    7.  
    8. /**
    9.  * @author 蒋明辉
    10.  * @data 2022/9/29 17:09
    11.  */
    12. @Data
    13. public class User {
    14.     @NotBlank(message ="手机号码不能为空")
    15.     @IsUserName(require = true)//这一个注解是自己自定义的注解
    16.     //手机号码
    17.     private String username;
    18.     @NotBlank(message = "密码不能为空")
    19.     //密码
    20.     private String password;
    21. }

      2.6 exception模块 

        BusinessException

    1. package com.jmh.springboot03.exception;
    2.  
    3. import com.jmh.springboot03.utils.JsonResponseBody;
    4. import com.jmh.springboot03.utils.JsonResponseStatus;
    5. import lombok.AllArgsConstructor;
    6. import lombok.Data;
    7. import lombok.NoArgsConstructor;
    8.  
    9. /**
    10.  * @author 蒋明辉
    11.  * @data 2022/9/29 18:24
    12.  */
    13. @Data
    14. @AllArgsConstructor
    15. @NoArgsConstructor
    16. public class BusinessException extends RuntimeException{
    17.     private JsonResponseStatus jsonResponseStatus;
    18.  
    19. }

       GlobalExceptionHandler

    1. package com.jmh.springboot03.exception;
    2.  
    3. import com.jmh.springboot03.utils.JsonResponseBody;
    4. import com.jmh.springboot03.utils.JsonResponseStatus;
    5. import org.springframework.validation.BindException;
    6. import org.springframework.web.bind.annotation.ExceptionHandler;
    7. import org.springframework.web.bind.annotation.RestControllerAdvice;
    8.  
    9. /**
    10.  * @author 蒋明辉
    11.  * @data 2022/9/29 18:26
    12.  */
    13. @RestControllerAdvice
    14. public class GlobalExceptionHandler {
    15.  
    16.     @ExceptionHandler
    17.     public JsonResponseBody exceptionHandler(Exception e){
    18.         //e.printStackTrace();//打印异常信息
    19.         //定义一个jsonResponseBody
    20.         JsonResponseBody jsonResponseBody=null;
    21.         if(e instanceof BindException){//是否是BindException异常
    22.             //强转为BindException
    23.             BindException bindException=(BindException)e;
    24.             //实例化jsonResponseBody
    25.             jsonResponseBody=new JsonResponseBody<>();
    26.             //获取异常信息
    27.             String me = bindException.getFieldError().getDefaultMessage();
    28.             //将异常信息赋值给jsonResponseBody
    29.             jsonResponseBody.setCode(20020929);
    30.             jsonResponseBody.setMsg(me);
    31.  
    32.         }else {
    33.             jsonResponseBody=new JsonResponseBody<>(JsonResponseStatus.error);
    34.         }
    35.         return jsonResponseBody;
    36.     }
    37.  
    38. }

      2.7 controller模块

       LoginController

    1. package com.jmh.springboot03.controller;
    2.  
    3. import com.jmh.springboot03.exception.BusinessException;
    4. import com.jmh.springboot03.model.User;
    5. import com.jmh.springboot03.utils.JsonResponseBody;
    6. import com.jmh.springboot03.utils.JsonResponseStatus;
    7. import com.jmh.springboot03.utils.ValidatorUtils;
    8. import org.apache.commons.lang3.StringUtils;
    9. import org.springframework.stereotype.Controller;
    10. import org.springframework.validation.annotation.Validated;
    11. import org.springframework.web.bind.annotation.RequestMapping;
    12. import org.springframework.web.bind.annotation.RestController;
    13.  
    14. /**
    15.  * @author 蒋明辉
    16.  * @data 2022/9/29 17:06
    17.  */
    18. @RestController
    19. @RequestMapping("/user")
    20. public class LoginController {
    21.  
    22.     @RequestMapping("/toLogin")
    23.     public JsonResponseBody toLogin(@Validated User user){
    24.         //不要慌哈！ 虽然这里没有代码但是我们已经都交给JSR303 全局异常去做啦
    25.         return new JsonResponseBody<>();
    26.     }
    27.  
    28. }
    29.  
    30.  
    31.  
    32.  
    33.  
    34.  
    35.  
    36.  
    37.

     

  • 相关阅读:
    【Java面试】如何理解Spring Boot中的Starter？
    线程池执行的用户任务抛出异常会怎样
    SQLAlchemy 连接池
    【vue+nestjs】qq第三方授权登录【超详细】
    在机器学习领域中，One-Hot Encoding是什么
    Java--Spring事务
    Mybatis 框架 ( 四 ) QueryWrapper
    Python面试题：请解释 `__slots__` 的作用
    Map集合（TreeMap）的使用
    经纬高坐标转东北天坐标
  • 原文地址：https://blog.csdn.net/m0_63300795/article/details/127114996