编程知识 cdmana.com

Java Architect solution spring security (1) quick start (with complete project code)

1. After reading this article, you will get one for free SpringSecurity test demo Project source code ( Direct operation ).
2. You will learn how to quickly create a SpringSecurity project , To achieve a simple login function , It's easy to integrate into Springboot project .
3. see demo Running test results of the project , Learn more about SpringSecurity function ..

What is? Spring Security


Spring Security The predecessor was Acegi Security , yes Spring The framework used in the project group to provide security authentication services . It supports many authentication technologies , Such as LDAP、 be based on IEFT RFC Standards for 、Form-based authentication( Simple user interface ) wait . Generalization is : Control system login interception 、 User login authentication 、 User login token The authentication 、 System api Access control of simple user interface for resources such as interfaces .

In short , That is, the login logic and code implementation of the system do not need to be developed by ourselves , Use Spring Security Configuration development can be .

Compare Spring Security Login service and native login service



The development process of native login logic is as follows :

1) Write the login page form Code .

2) Write login controller Interface code .

3) Query the user information from the database according to the user name parameter passed in .

4) Compare the password data found and the password passed in , If the same, log in through , Otherwise the login fails .

Spring Security Login logic development process :

1) Write the login page form Code .

2)Spring Security Core configuration class development .

3) Realization UserDetailsService Interface , stay loadUserByUsername Method to load user information .

Why? SpringSecurity Login business development workload is small



SpringSecurity Less development work , It's because it has a very complete modeling of the login business , The whole process of logging into the business , There is not much local logic to be developed by developers themselves , These include : Custom login page , Custom user data acquisition source (UserDetailsService Implementation class )

Use SpringSecurity How cool is it to provide security services for the system , The picture below represents my heart at the moment .

alt


Quick start


SpringBoot project pom rely on

This is integration SpringSecurity What we need to rely on jar package .

<!--security start-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-security</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

 

Springboot Project pom The package must contain at least two files .

SpringSecurity Configuration class

Configuration class should inherit abstract class WebSecurityConfigurerAdapter, And use annotations @Configuration、@EnableGlobalMethodSecurity(prePostEnabled = true) Decorated configuration class .

/**
 * @Author: Galen
 * @Date: 2019/3/27-14:43
 * @Description: spring-security The core configuration of rights management 
 **/
@Configuration
@EnableGlobalMethodSecurity(prePostEnabled = true)
public class WebSecurityConfig extends WebSecurityConfigurerAdapter {
    @Autowired
    private UserSecurityService userSecurityService;

    /**
     * @Author: jackdking
     * @Description:  To configure userDetails Data source , Password encryption format 
     * @Date: 2020/5/21-5:24
     * @Param: [auth]
     * @return: void
     **/
    @Override
    protected void configure(AuthenticationManagerBuilder auth) throws Exception {
        auth.userDetailsService(userSecurityService)
                .passwordEncoder(new BCryptPasswordEncoder());//  Implementation of custom login verification 
    }

    /**
     * @Author: Galen
     * @Description:  Allocate released resources 
     * @Date: 2019/3/28-9:23
     * @Param: [web]
     * @return: void
     **/
    @Override
    public void configure(WebSecurity web) throws Exception {
        web.ignoring().antMatchers("/login.html", "/index.html","/css/**", "/static/**", "/login_p", "/favicon.ico")
                //  to  swagger  release ; Resources that do not require permission to access 
                .antMatchers("/swagger-ui.html", "/swagger-resources/**", "/images/**", "/webjars/**", "/v2/api-docs", "/configuration/ui", "/configuration/security");
    }

    /**
     * @Author: Galen
     * @Description:  Intercept configuration 
     * @Date: 2019/4/4-10:44
     * @Param: [http]
     * @return: void
     **/
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests()
                //  Make it support cross domain 
                .requestMatchers(CorsUtils :: isPreFlightRequest).permitAll()
                //  Other paths need to be authorized to access 
                .anyRequest().authenticated()

                .and()
                .formLogin().loginPage("/login_p")//  Set up login page ,
                // Strangely enough   This url There was no access to .
                .loginProcessingUrl("/login")//  Custom login interface , This interface must be with your login page form Of action The address is the same . Otherwise, keep going into login_p page : If loginProcessingUrl Not configured , The default is to follow loginPage equally 
                .usernameParameter("username").passwordParameter("password")// tell security form Parameter expressions for the user name and password of the form .
                .failureHandler(new MyAuthenticationFailureHandler())//  This failure handling   Follow  failureUrl  Configuration is mutually exclusive .  Choose only one of the two 
                .successHandler(new MyAuthenticationSuccessHandler())// Follow defaultSuccessUrl Mutually exclusive  , This support goes back to json data . If you don't set this successful processor , May be an error  999.
//                .defaultSuccessUrl("/index")   // Follow successHandler Configure mutual exclusion , This support redirects to the success page .  Visit the specified page , The user is not logged in , Jump to the login page , If login is successful , Jump to the user to visit the specified page , Users visit the login page , Default jump page 
//                .failureUrl("/error_p") //  Redirection failed page     Follow  failureHandler  Configuration is mutually exclusive .  Choose only one of the two 
                .permitAll()

                .and()
                .csrf().disable(); // close csrf
    }
}

 

  • Configuration class override configure(AuthenticationManagerBuilder auth), Set user information source interface userDetailsService Implementation class of , And the user password encryption implementation object BCryptPasswordEncoder.
  • Configuration class override configure(WebSecurity web), inform security Frame what url You can visit without logging in , For example, some css file 、js file 、 Login page and so on .
  • Configuration class override configure(HttpSecurity http), inform security Some information about login service , For example, the login page 、 Custom login interface 、form Parameter expressions for the user name and password of the form 、 Login failed or succeeded handler class .

userDetailsService Development of

In this implementation class ,security The framework allows developers to customize the source of user information : It can be in the code , Or the database 、 Cache server 、 Third party services, etc . In this demo In the project , We use it more simply , Write directly in code , Created SecuritySysUser Object returned to Security.

SecuritySysUser securityUser = new SecuritySysUser();
securityUser.setUsername(username);
securityUser.setPassword("$2a$10$4H1JSQxyrJlguu0/V4DnR.s2NBjE.k6rI6.W.1AFL0UEnR2IR2/5y");
securityUser.setEnabled(true);

List<SecuritySysRole> roles = new ArrayList<>();
SecuritySysRole role = new SecuritySysRole();
role.setNameCn("ROLE_ADMIN");
securityUser.setRoles(roles);

if (securityUser == null) {
    throw new UsernameNotFoundException(" Wrong user name ");
}

log.info(" User information :{}" , securityUser.toString());

return securityUser;

 

Here we are , Use security Framework to develop user login business is over , Let's see how it works .

In this paper, the demo Project access is at the bottom of the article .

Right click on the project file com.jackdking.security.SpringSecurityApplication, choice Run As -> Java Application.

Browser input http://localhost:9090, Get into login Login page .

alt

enter one user name / password :admin/admin, Click the login button , Then check the login back in json Information .

alt

Login successfully returned to json The data is security Results of successful login to the processor framework :successHandler(new MyAuthenticationSuccessHandler()).

@Override
public void onAuthenticationSuccess(HttpServletRequest request, HttpServletResponse response, Authentication authentication) throws IOException, ServletException {
    response.setContentType("application/json;charset=utf-8");
    RespBean respBean = RespBean.ok("【MyAuthenticationSuccessHandler】 Login successful !", SecurityUserUtil.getCurrentUser());
    new GalenWebMvcWrite().writeToWeb(request,response, respBean);
    System.out.println("【MyAuthenticationSuccessHandler】 Login successful !");
}

 

Enter the wrong user name and password , Back to json Information , Is the first exception error class in the error handler UsernameNotFoundException.

alt

Login failure returned json The data is security The login of the framework failed. The result returned by the processor is :failureHandler(new MyAuthenticationFailureHandler()).

 response.setContentType("application/json;charset=utf-8");
RespBean respBean;
if (exception instanceof BadCredentialsException ||
        exception instanceof UsernameNotFoundException) {
    respBean = RespBean.error(" Wrong account name or password !");
} else if (exception instanceof LockedException) {
    respBean = RespBean.error(" The account is locked , Please contact the Administrator !");
} else if (exception instanceof CredentialsExpiredException) {
    respBean = RespBean.error(" Password expired , Please contact the Administrator !");
} else if (exception instanceof AccountExpiredException) {
    respBean = RespBean.error(" Account expired , Please contact the Administrator !");
} else if (exception instanceof DisabledException) {
    respBean = RespBean.error(" Account is disabled , Please contact the Administrator !");
} else {
    respBean = RespBean.error(" Login failed !");
}

System.out.println(" Failure logic processing .");
//response.setStatus(401);
new GalenWebMvcWrite().writeToWeb(request, response, respBean);

 

As an architect , Of course, I hope the system can use mature 、 Security service framework with rich features , and security It's a good choice . And whether it's from building security services to manpower 、 test 、 Operation and maintenance 、 Consider the cost ,security They are very fragrant .

Spring Security The configuration development of security service framework also greatly improves the development efficiency of the whole team , If the system makes its own security service framework , In the future, the handover cost of team members will also be very high , It will also be accompanied by higher risk costs .

 

To view more “Java Architect solutions ” Series articles as well as SpringBoot2.0 Learning examples

 

 

complete demo project , Please pay attention to the official account. “ Cutting edge technology bot“ And send the "SEC-ONE" obtain .

alt

版权声明
本文为[Blank jackdking]所创,转载请带上原文链接,感谢

Scroll to Top