Spring-security整理

出于某些原因，需要学习一下spring的安全框架。（研究半天，如果单单说用户认证和授权这块儿，我感觉还是shiro好用。）

spring security介绍可以参考一下以下文档：

（满满的羡慕啊）我这里就不扯了。

http://www.tianshouzhi.com/api/tutorials/spring_security_4/252

一、先贴代码

下边是我的项目结构

当然我采用的是springboot + thymeleaf + mybatis + mysql

1.用到的pom.xml

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.0.1</version>
        </dependency>

<!--     mysql    -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.32</version>
        </dependency>

<!--     lombok   -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.8</version>
            <scope>provided</scope>
        </dependency>

<!--    security+thymeleaf    -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-security</artifactId>
            <version>2.1.5.RELEASE</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
<!--            <version>2.1.3.RELEASE</version>-->
        </dependency>
        <dependency>
            <groupId>org.thymeleaf.extras</groupId>
            <artifactId>thymeleaf-extras-springsecurity4</artifactId>
            <version>3.0.2.RELEASE</version>
        </dependency>

2.核心配置类

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.crypto.password.MessageDigestPasswordEncoder;

@Configuration
@EnableWebSecurity
public class WebSecurityConfig extends WebSecurityConfigurerAdapter {
    @Bean
    UserDetailsService customUserService(){ //注册UserDetailsService 的bean
        return new UserDetailsServiceImpl();
    }

    @Override
    protected void configure(AuthenticationManagerBuilder auth) throws Exception {
        auth.userDetailsService(customUserService()).passwordEncoder(new MessageDigestPasswordEncoder("MD5")); //user Details Service验证
    }
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests()
                .anyRequest().authenticated() //authenticated任何请求,登录后可以访问
                .and()
                .csrf().disable()
                .formLogin()
                .loginPage("/user/login")//
                .defaultSuccessUrl("/user/index")
                .failureUrl("/user/login?error=true")
                .permitAll() //登录页面用户任意访问
                .and()
                .logout().permitAll(); //注销行为任意访问
    }
}

3.UserDetailsServiceImpl

import com.qx.demo.entity.RolePo;
import com.qx.demo.entity.UserPo;
import com.qx.demo.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.core.authority.SimpleGrantedAuthority;
import org.springframework.security.core.userdetails.User;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.core.userdetails.UsernameNotFoundException;

import java.util.HashSet;
import java.util.Set;

public class UserDetailsServiceImpl implements UserDetailsService {
    @Autowired
    UserService service;
    @Override
    public UserDetails loadUserByUsername(String s) throws UsernameNotFoundException {
        UserPo user = service.getUserById(s);
        if (user==null){
            throw new UsernameNotFoundException("用户名不存在");
        }
        Set<SimpleGrantedAuthority> authorities = new HashSet<>();
        for (RolePo item:user.getRoles()){
            authorities.add(new SimpleGrantedAuthority(item.getRName()));
            System.out.println(item.getRName());
        }
        return new User(user.getUsername(),user.getPassword(),authorities);
    }
}

4.控制层Controller

import com.qx.demo.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.core.Authentication;
import org.springframework.security.core.userdetails.User;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;

@Controller
@RequestMapping("user")
public class UserController {
    @Autowired
    private UserService service;
    @RequestMapping("login")
    public ModelAndView toLogin(HttpServletRequest request){
        ModelAndView mv= new ModelAndView("login");
        String error = request.getParameter("error");
        if (error!=null && error.equals("true")){
            System.out.println("登录失败");
        }
        return mv;
    }
    @RequestMapping("index")
    public String getUserById( Authentication authentication){
        User principal = (User)authentication.getPrincipal();
        if (authentication!=null)
            System.out.println(authentication.getCredentials()+",
"+authentication.getDetails()+",
"+authentication.getPrincipal()+",
"+authentication.getName());
        return "index";
    }
}

5.实体类

import lombok.Data;
import lombok.ToString;

import java.util.List;

@Data
@ToString
public class UserPo {
    private int uid;
    private String username;
    private String password;
    private List<RolePo> roles;
}

import lombok.Data;
import lombok.ToString;

import java.util.List;

@Data
@ToString
public class RolePo {
    private int rid;
    private String rName;
    private List<PermissionPo> pers;
}

import lombok.Data;
import lombok.ToString;

@Data
@ToString
public class PermissionPo {
    private int pid;
    private String pName;
    private String pPer;
}

6.Dao层

import com.qx.demo.entity.UserPo;

public interface UserMapper {
    UserPo getUserByUsername(String username);
}

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.qx.demo.dao.UserMapper">

    <resultMap id="getRoleAndPer" type="com.qx.demo.entity.UserPo">
        <id column="uid" property="uid"></id>
        <result column="username" property="username"></result>
        <result column="password" property="password"></result>
        <collection property="roles" ofType="com.qx.demo.entity.RolePo">
            <id column="rid" property="rid"></id>
            <result column="r_name" property="rName"></result>
            <collection property="pers" ofType="com.qx.demo.entity.PermissionPo">
                <id column="pid" property="pid"></id>
                <result column="p_name" property="pName"></result>
                <result column="p_per" property="pPer"></result>
            </collection>
        </collection>
    </resultMap>
    <select id="getUserByUsername"  parameterType="String" resultMap="getRoleAndPer">
        SELECT * FROM qx_user qu
            INNER JOIN `qx_user_role` qur ON qu.`uid`=qur.`u_id`
            INNER JOIN qx_role qr ON qur.`r_id` = qr.`rid`
            INNER JOIN qx_role_per qrp ON qr.`rid`=qrp.`pid`
            INNER JOIN qx_permission qp ON qrp.`pid`=qp.`pid`
            WHERE username=#{_parameter}
    </select>
</mapper>

7.service层

import com.qx.demo.entity.UserPo;

public interface UserService {
    UserPo getUserById(String id);
}

import com.qx.demo.dao.UserMapper;
import com.qx.demo.entity.UserPo;
import com.qx.demo.service.UserService;
import org.springframework.stereotype.Service;

import javax.annotation.Resource;

@Service
public class UserServiceImpl implements UserService {
    @Resource
    private UserMapper mapper;
    @Override
    public UserPo getUserById(String  username) {
        return mapper.getUserByUsername(username);
    }
}

8.application.properties

mybatis.mapper-locations=/mapper/*.xml
mybatis.type-aliases-package=com.qx.demo.entity

spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql:///qx
spring.datasource.username=root
spring.datasource.data-password=root

spring.thymeleaf.mode=HTML5
spring.thymeleaf.cache=false

logging.level.com.qx.demo.dao=debug

二、再来看看spring-security的大概的执行流程

1.从上边图不难看出，spring-security的核心应该就是ProviderManager，但是ProviderManager并不直接执行认证和授权等相关操作，而是委托给AuthenticationProvider去完成相关操作，而对于每一个ProviderManager都是可以有多个AuthenticationProvider的。

2.AuthenticationProvider首先会找到UserDetailsService（有我们自己定义的）在数据库中查找用户信息。如果没有找到将会返回一个空的UserDetails，由于UserDetails是一个接口，我是在实体类中实现了该接口（那么这样我们就可以返回一个空壳user对象了）。

   当然，如果找到了我们可以直接授权并将UserDetailsService返回。

3.AuthenticationProvider就收到一个非空的UserDetailsService，接下来就该进行密码比对了。这时AuthenticationProvider将会调用PasswordEncoder进行密码比对。

4.无论成功与否，spring-security都会在对应的过滤器上找到响应的响应方式，并响应给客户。

Spring-security和shiro一样，都是基于过滤器，所以我们免不了去配置一些过滤器：

　　

当然，在前边的代码中已经体现过，该配置应该是在spring-security的核心配置类中进行配置（如果是xml也是一样的，大同小异嘛）。

上图是基于前后端分离，给前端返回一个json格式响应体的，比如登录成功时：

如图所示我们只需要实现AuthenticationSuccessHandler接口，并重写onAuthenticationSuccess方法即可。这个方法体完全就是一个类似与Servlet的方法体，有一定javaee基础的应该都没啥问题的。同样的道理如果登陆失败我们可以实现AuthenticationFailureHandler等等。

嗯，可能我忘了记录一个至关重要的玩意了，没错就是他：

你没看错，这就是一个基于用户名和密码的filter，spring-security拼什么这么智能，其实很简单就是一系列过滤器的使用。在源码中我们不难看出spring-security是设置了默认的登录地址的  /login,并且请求只允许POST请求。同时他也是spring-security默认登录过滤器。由于Java的开放原则的原因，你要是看他不爽你也可以自定义一个过滤器，你只需要继承一下AbstractAuthenticationProcessingFilter，重写其中的一些方法就好了。一般情况下我觉得默认的就可以了。

同样的与shiro雷同UsernamePasswordAuthenticationToken就是一个主体，当然保存的是客户端输入的登录信息。他最终是与UserDetailsService（在数据库中查到的信息）相对比得到登录结果。

对于用户信息来说我想密码应该是最重要的了，那么我们现在可以看看PasswordEncoder了

以上是security5中所有的PasswordEncoder了，当然，上边截图中有一个是我重写的PasswordEncoder（MyPasswordEncoder是我重写的）。这里我就不解释这些密码比对器都是什么作用了，如果有不了解的大家可以自己下去查询一下资料。我们公司要求的用的是MD5加密的方式，由于它是普通的散列，上网一百度就能看到答案，所以我需要重写一下PasswordEncoder。

同样的我们需要实现这个接口，我们需要重写两个方法encode()、matches()。一眼看上去不难发现，matches一定是用户认证的，那我们就可以把重点放到这个方法下了。

因为是例子，所以我写的比较简单了，显而易见我用的Spring自带的MD5加密工具了。

当然，spring-security是比较推荐 BCryptPasswordEncoder，我也象征性的看了一下源码并不是很难理解大家可以去看下。