SpringBoot集成security（3）|（security的自定义登录以及异常处理）

「爱情、让人受尽委屈。」 2023-10-03 21:57 15阅读 0赞

## SpringBoot集成security（3）|（security的前后端分离登录以及响应处理） ##

--------------------

### 文章目录  SpringBoot集成security（3）|（security的前后端分离登录以及响应处理）  @\[TOC\]  前言  一、项目依赖  二、自定义响应处理  三、自定义登录响应类  四、自定义登录实现  1、UsernamePasswordAuthenticationFilter介绍  2、自定义用户名密码登录实现  3、security配置  四、验证登录情况  1、编写测试接口  2、调用接口提示  总结 ###

章节  
第一章链接: [SpringBoot集成security（1）|（security入门）][SpringBoot_security_1_security]  
第二章链接: [SpringBoot集成security（2）|（security自定义配置）][SpringBoot_security_2_security]  
第三章链接: [SpringBoot集成security（3）|（security的前后端分离登录以及响应处理）][SpringBoot_security_3_security]  
第四章链接: [SpringBoot集成security（4）|（security基于JWT实现前后端分离自定义登录）][SpringBoot_security_4_security_JWT]

## 前言 ##

上一章节我们介绍了springboot基于security的用户配置，权限配置，资源配置。但是实际中发现，认证用的是默认的login表单登录，且认证授权异常的报错都比较粗暴直接放回一串JSON，这样很不友好，鉴于现在大多项目都是前后端分离，我们这个章节来实现基于前后端分离的登录，以及提示管理

本片文章是在上一篇基础上进行的扩展，如果大家对项目基础不是很清楚请查看上一篇文章

## 一、项目依赖 ##

> 主要包含security的依赖以及一些工具类的依赖

<parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.5.7</version>
            <relativePath/>
        </parent>
       <dependencies>
           
           <dependency>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-starter</artifactId>
           </dependency>
           <dependency>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-starter-test</artifactId>
               <scope>test</scope>
           </dependency>
           <dependency>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-starter-web</artifactId>
           </dependency>
           
    
           
           <dependency>
               <groupId>com.github.xiaoymin</groupId>
               <artifactId>knife4j-spring-ui</artifactId>
               <version>3.0.3</version>
           </dependency>
           <dependency>
               <groupId>io.springfox</groupId>
               <artifactId>springfox-swagger2</artifactId>
               <version>3.0.0</version>
           </dependency>
    
           
           <dependency>
               <groupId>org.apache.commons</groupId>
               <artifactId>commons-lang3</artifactId>
               <version>3.12.0</version>
           </dependency>
    
           <dependency>
               <groupId>org.apache.commons</groupId>
               <artifactId>commons-collections4</artifactId>
               <version>4.1</version>
           </dependency>
    
           <dependency>
               <groupId>com.google.guava</groupId>
               <artifactId>guava</artifactId>
               <version>30.1.1-jre</version>
           </dependency>
    
           
           <dependency>
               <groupId>com.alibaba</groupId>
               <artifactId>fastjson</artifactId>
               <version>1.2.49</version>
           </dependency>
           <dependency>
               <groupId>org.projectlombok</groupId>
               <artifactId>lombok</artifactId>
               <optional>true</optional>
           </dependency>
           <dependency>
               <groupId>commons-codec</groupId>
               <artifactId>commons-codec</artifactId>
               <version>1.15</version>
           </dependency>
    
           
           <dependency>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-starter-security</artifactId>
           </dependency>
    
           
           <dependency>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-starter-data-jpa</artifactId>
           </dependency>
           <dependency>
               <groupId>mysql</groupId>
               <artifactId>mysql-connector-java</artifactId>
               <scope>runtime</scope>
           </dependency>
       </dependencies>

## 二、自定义响应处理 ##

> 自定义响应处理主要是定义好响应格式，方便前后端连调

1、定义响应体ResponseHandle

@Data
    public class ResponseHandle<T> {
        
        private String status;
        private String desc;
        private T data;
    
        // 成功 无参构成函数
        public static ResponseHandle SUCCESS(){
        
            ResponseHandle result = new ResponseHandle();
            result.setDesc("成功");
            result.setResultCode(HttpCode.SUCCESS);
            return result;
        }
        //成功 有返回数据构造函数
        public static ResponseHandle SUCCESS(Object data){
        
            ResponseHandle result = new ResponseHandle();
            result.setData(data);
            result.setResultCode(HttpCode.SUCCESS);
            return result;
        }
    
        /**
         * 失败，指定status、desc
         */
        public static ResponseHandle FAIL(String status, String desc) {
        
            ResponseHandle result = new ResponseHandle();
            result.setStatus(status);
            result.setDesc(desc);
            return result;
        }
    
        /**
         * 失败，指定ResultCode枚举
         */
        public static ResponseHandle FAIL(HttpCode resultCode) {
        
            ResponseHandle result = new ResponseHandle();
            result.setResultCode(resultCode);
            return result;
        }
        /**
         * 把ResultCode枚举转换为ResResult
         */
        private void setResultCode(HttpCode code) {
        
            this.status = code.code();
            this.desc = code.message();
        }
    }

2、定义响应枚举HttpCode

public enum HttpCode {
        
    
        // 成功状态码
        SUCCESS("00000", "成功"),
        UNKNOWN_ERROR("99999", "服务未知异常"),
        // 系统500错误
        SYSTEM_ERROR("10000", "系统异常，请稍后重试"),
    
    
        // 认证错误：20001-29999
        USER_NOAUTH("20000", "用户未登录"),
        TOKEN_ERROR("20001", "生成token失败"),
        LOGIN_ERROR("20002", "登录失败"),
        USER_LOCKED("20004", "账户已锁定"),
        USER_PASS_OUT("20005", "用户名或密码错误次数过多"),
        USER_NOTFIND_ERROR("20006", "没有找到用户"),
        USER_ERROR("20007", "用户名或密码不正确"),
    
        ;
    
    
        private String code;
    
        private String message;
    
        HttpCode(String code, String message) {
        
            this.code = code;
            this.message = message;
        }
    
        public String code() {
        
            return this.code;
        }
    
        public String message() {
        
            return this.message;
        }
    }

## 三、自定义登录响应类 ##

> 主要是登录成功、登录失败、没有登录、登出等场景下的返回前端信息格式

1、登录失败处理

@Component
    public class LoginFailureHandler implements AuthenticationFailureHandler {
        
    
        @Override
        public void onAuthenticationFailure(HttpServletRequest request, HttpServletResponse response, AuthenticationException exception) throws IOException, ServletException {
        
            response.setCharacterEncoding("UTF-8");
            response.setContentType("application/json; charset=utf-8");
            response.setStatus(HttpServletResponse.SC_OK);
            ResponseHandle fail = ResponseHandle.FAIL(HttpCode.USER_ERROR);
            response.getWriter().write(JSONObject.toJSONString(fail));
        }
    }

2、登录成功处理

public class LoginSuccessHandler implements AuthenticationSuccessHandler {
        
    
    
        @Override
        public void onAuthenticationSuccess(HttpServletRequest request, HttpServletResponse response, FilterChain chain, Authentication authentication) throws IOException, ServletException {
        
        }
    
        @Override
        public void onAuthenticationSuccess(HttpServletRequest request, HttpServletResponse response, Authentication authentication) throws IOException, ServletException {
        
            response.setCharacterEncoding("UTF-8");
            response.setContentType("application/json; charset=utf-8");
            response.setStatus(HttpServletResponse.SC_OK);
            ResponseHandle success = ResponseHandle.SUCCESS(authentication);
            response.getWriter().write(JSONObject.toJSONString(success));
        }
    }

3、登出成功处理

public class LogoutMySuccessHandler implements LogoutSuccessHandler {
        
    
        @Override
        public void onLogoutSuccess(HttpServletRequest request, HttpServletResponse response, Authentication authentication) throws IOException, ServletException {
        
            response.setCharacterEncoding("UTF-8");
            response.setContentType("application/json; charset=utf-8");
            response.setStatus(HttpServletResponse.SC_OK);
            ResponseHandle success = ResponseHandle.SUCCESS("登出成功");
            response.getWriter().write(JSONObject.toJSONString(success));
        }
    }

4、没有登录处理

public class NoLoginHandler implements AuthenticationEntryPoint {
        
    
        @Override
        public void commence(HttpServletRequest request, HttpServletResponse response, AuthenticationException authException) throws IOException, ServletException {
        
            response.setCharacterEncoding("UTF-8");
            response.setContentType("application/json; charset=utf-8");
            response.setStatus(HttpServletResponse.SC_OK);
            ResponseHandle fail = ResponseHandle.FAIL(HttpCode.USER_NOAUTH);
            response.getWriter().write(JSONObject.toJSONString(fail));
        }
    }

## 四、自定义登录实现 ##

### 1、UsernamePasswordAuthenticationFilter介绍 ###

> UsernamePasswordAuthenticationFilter是security默认实现用户名密码登录的实现类。当我们使用默认的login表单等路就会进入到该类中进行用户登录处理，如果我们想自定义登录接口，那么我们要重写该类。

### 2、自定义用户名密码登录实现 ###

> 该处用户可以自定义自己的实现逻辑，例如用户密码加密，返回参数等。

@Slf4j
    public class MyUsernamePasswordAuthenticationFilter extends UsernamePasswordAuthenticationFilter {
        
        @Override
        public Authentication attemptAuthentication(HttpServletRequest request, HttpServletResponse response) throws AuthenticationException {
        
            if(!request.getMethod().equals("POST")){
        
                throw new AuthenticationServiceException("Authentication method not supported: " + request.getMethod());
            }
            if(request.getContentType().equals("application/json")){
        
                try {
        
                    //参数转换为map
                    Map map = new ObjectMapper().readValue(request.getInputStream(),Map.class);
                    String username = (String) map.get("username");
                    String password = (String) map.get("password");
                    UsernamePasswordAuthenticationToken authRequest = new UsernamePasswordAuthenticationToken(username, password);
                    setDetails(request, authRequest);
                    return this.getAuthenticationManager().authenticate(authRequest);
                } catch (IOException e) {
        
                    e.printStackTrace();
                }
            }
            return super.attemptAuthentication(request, response);
        }
    }

### 3、security配置 ###

> 配置security用户来源、认证模式、过滤器等，这里我们定义了自己的/mylogin登录接口

@Configuration
    @EnableWebSecurity
    public class SecurityConfig extends WebSecurityConfigurerAdapter {
        
    
        @Autowired
        private UserServiceImpl userService;
    
    
        /**
         * 常用的三种存储方式，项目找那个用的最多的为，自定义用户存储
         *
         * @param auth
         * @throws Exception
         */
        @Override
        protected void configure(AuthenticationManagerBuilder auth) throws Exception {
        
            //1、内存用户配置
    //        auth.inMemoryAuthentication().passwordEncoder(bCryptPasswordEncoder())
    //                .withUser("admin").password(bCryptPasswordEncoder().encode("123456")).authorities("ADMIN")
    //                .and()
    //                .withUser("test").password(bCryptPasswordEncoder().encode("123456")).authorities("TEST");
            //2、数据库用户配置
    //        auth.jdbcAuthentication().dataSource(dataSource).passwordEncoder(passwordEncoder())
    //                .usersByUsernameQuery(
    //                        "select username, password, status from Users where username = ?")
    //                .authoritiesByUsernameQuery(
    //                        "select username, authority from Authority where username = ?");
            //3、自定义用户存储
            auth.userDetailsService(userService)
                    .passwordEncoder(bCryptPasswordEncoder());
        }
    
        /**
         * configure(WebSecurity)用于影响全局安全性(配置资源，设置调试模式，通过实现自定义防火墙定义拒绝请求)的配置设置。
         * 一般用于配置全局的某些通用事物，例如静态资源等
         *
         * @param web
         */
        @Override
        public void configure(WebSecurity web) {
        
            web.ignoring()
                    .antMatchers(HttpMethod.OPTIONS, "/**")  ///跨域请求预处理
                    .antMatchers("/favicon.ico")
                    .antMatchers("/swagger**")   // 以下swagger静态资源、接口不拦截
                    .antMatchers("/doc.html")
                    .antMatchers("/swagger-resources/**")
                    .antMatchers("/v2/api-docs")
                    .antMatchers("/webjars/**")
                    .antMatchers("/test/**")
                    .antMatchers("/js/**", "/css/**", "/images/**");  // 排除html静态资源
        }
    
        /**
         * 配置接口拦截
         * configure(HttpSecurity)允许基于选择匹配在资源级配置基于网络的安全性，
         * 也就是对角色所能访问的接口做出限制
         *
         * @param httpSecurity 请求属性
         * @throws Exception
         */
        @Override
        protected void configure(HttpSecurity httpSecurity) throws Exception {
        
            httpSecurity.authorizeRequests()
                    .antMatchers(HttpMethod.GET, "/demo/get").permitAll()
                    //指定权限为ROLE_ADMIN才能访问，这里和方法注解配置效果一样，但是会覆盖注解
                    .antMatchers("/demo/delete").hasRole("ADMIN")
                    // 所有请求都需要验证
                    .anyRequest().authenticated()
                    .and()
                    //.httpBasic() Basic认证，和表单认证只能选一个
                    // 使用表单认证页面
                    .formLogin()
                    .and().addFilterAt(loginFilter(), UsernamePasswordAuthenticationFilter.class)
                    .exceptionHandling()
                    .authenticationEntryPoint(new NoLoginHandler())
                    .and()
                    .logout()
                    .logoutSuccessHandler(new LogoutMySuccessHandler())
                    .and()
                    .csrf().disable();
        }
    
    
        /**
         * 配置用户认证方式
         *
         * @return
         * @throws Exception
         */
        @Override
        @Bean
        public AuthenticationManager authenticationManagerBean() throws Exception {
        
            return super.authenticationManagerBean();
        }
    
    
        /**
         * 自定义过滤器，用来替换security的默认过滤器（UsernamePasswordAuthenticationFilter），
         * 实现自定义的login接口，接口路径为了区别默认的/login我们定义为/mylogin
         *
         * @return
         * @throws Exception
         */
        @Bean
        public MyUsernamePasswordAuthenticationFilter loginFilter() throws Exception {
        
            MyUsernamePasswordAuthenticationFilter loginFilter = new MyUsernamePasswordAuthenticationFilter();
            loginFilter.setFilterProcessesUrl("/mylogin");
            loginFilter.setAuthenticationSuccessHandler(new LoginSuccessHandler());
            loginFilter.setAuthenticationFailureHandler(new LoginFailureHandler());
            loginFilter.setAuthenticationManager(authenticationManagerBean());
            return loginFilter;
        }
    
        /**
         * 使用security 提供的加密规则（还有其他加密方式）
         *
         * @return
         */
        @Bean
        public BCryptPasswordEncoder bCryptPasswordEncoder() {
        
            return new BCryptPasswordEncoder();
        }
    
    }

## 四、验证登录情况 ##

### 1、编写测试接口 ###

@Api(tags = {
        "演示相关接口"})
    @RestController
    @RequestMapping("/demo")
    public class DemoCtrl {
        
    
        @Autowired
        private UserRepository userRepository;
    
        @Autowired
            private BCryptPasswordEncoder bCryptPasswordEncoder;
    
    
        @ApiOperation(value = "获取接口", notes = "获取接口")
        @GetMapping(value = "/get")
        public ResponseHandle get() {
        
            return ResponseHandle.SUCCESS("获取数据成功");
        }
        @ApiOperation(value = "获取接口", notes = "获取接口")
        @GetMapping(value = "/find")
        public ResponseHandle find() {
        
            return ResponseHandle.SUCCESS("查询数据成功");
        }
    
        @ApiOperation(value = "注册用户", notes = "注册")
        @PostMapping("/register")
        public String registerUser(@RequestBody Map<String, String> registerUser) {
        
            User user = new User();
            user.setUsername(registerUser.get("username"));
            user.setPassword(bCryptPasswordEncoder.encode(registerUser.get("password")));
            user.setRole("ROLE_USER");
            User save = userRepository.save(user);
            return save.toString();
        }
    
        @ApiOperation(value = "修改用户", notes = "修改")
        @GetMapping("/update")
    //    @PreAuthorize("hasRole('ROLE_ADMIN')")
        public ResponseHandle updateUser() {
        
            return ResponseHandle.SUCCESS("数据修改成功");
        }
        @ApiOperation(value = "删除用户", notes = "删除")
        @GetMapping("/delete")
        public ResponseHandle deleteUser() {
        
            return ResponseHandle.SUCCESS("数据删除成功");
        }
    }

### 2、调用接口提示 ###

> 1、没有登录调用接口

![在这里插入图片描述][e749caa2385743d89738e8fca9f7a441.png]

> 2、调用登录接口

![在这里插入图片描述][78af6980370047a3aef93db5a0df397e.png]

## 总结 ##

到此springboot集成了security完成了用户的数据库配置以及自定义登录，并且完善了登录相关的响应，这样方便前后端统一处理。这样的登录可以实现单一项目的需求，但是考虑到多项目间的登录认证，该方案还是有很多问题，接下来我们将继续完成基于token的认证方式

第一章链接: [SpringBoot集成security（1）|（security入门）][SpringBoot_security_1_security]  
第二章链接: [SpringBoot集成security（2）|（security自定义配置）][SpringBoot_security_2_security]  
第三章链接: [SpringBoot集成security（3）|（security的前后端分离登录以及响应处理）][SpringBoot_security_3_security]  
第四章链接: [SpringBoot集成security（4）|（security基于JWT实现前后端分离自定义登录）][SpringBoot_security_4_security_JWT]

[SpringBoot_security_1_security]: https://blog.csdn.net/Oaklkm/article/details/127904641
[SpringBoot_security_2_security]: https://blog.csdn.net/Oaklkm/article/details/127918927
[SpringBoot_security_3_security]: https://blog.csdn.net/Oaklkm/article/details/128144676
[SpringBoot_security_4_security_JWT]: https://blog.csdn.net/Oaklkm/article/details/128190531
[e749caa2385743d89738e8fca9f7a441.png]: https://img-blog.csdnimg.cn/e749caa2385743d89738e8fca9f7a441.png
[78af6980370047a3aef93db5a0df397e.png]: https://img-blog.csdnimg.cn/78af6980370047a3aef93db5a0df397e.png