Spring Boot 集成 Spring Security 實現權限認證模塊

時間 2019-12-13

標籤 spring boot 集成 security 實現權限認證模塊欄目 Spring 简体版

原文原文鏈接

做者：王帥@CodeSheepmysql

寫在前面

關於 Spring Security web

Web系統的認證和權限模塊也算是一個系統的基礎設施了，幾乎任何的互聯網服務都會涉及到這方面的要求。在Java EE領域，成熟的安全框架解決方案通常有 Apache Shiro、Spring Security等兩種技術選型。Apache Shiro簡單易用也算是一大優點，但其功能仍是遠不如 Spring Security強大。Spring Security能夠爲 Spring 應用提供聲明式的安全訪問控制，起經過提供一系列能夠在 Spring應用上下文中可配置的Bean，並利用 Spring IoC和 AOP等功能特性來爲應用系統提供聲明式的安全訪問控制功能，減小了諸多重複工做。spring

關於JWT sql

JSON Web Token (JWT)，是在網絡應用間傳遞信息的一種基於 JSON的開放標準（(RFC 7519)，用於做爲JSON對象在不一樣系統之間進行安全地信息傳輸。主要使用場景通常是用來在身份提供者和服務提供者間傳遞被認證的用戶身份信息。關於JWT的科普，能夠看看阮一峯老師的《JSON Web Token 入門教程》。數據庫

本文則結合 Spring Security和 JWT兩大利器來打造一個簡易的權限系統。json

本文實驗環境以下：安全

Spring Boot版本： 2.0.6.RELEASE網絡
IDE： IntelliJIDEA2018.2.4session

另外本文實驗代碼置於文尾，須要自取。框架

設計用戶和角色

本文實驗爲了簡化考慮，準備作以下設計：

設計一個最簡角色表 role，包括 角色ID和 角色名稱

設計一個最簡用戶表 user，包括 用戶ID， 用戶名， 密碼

再設計一個用戶和角色一對多的關聯表 user_roles 一個用戶能夠擁有多個角色

建立 Spring Security和 JWT加持的 Web工程

pom.xml 中引入 Spring Security和 JWT所必需的依賴

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-security</artifactId>
</dependency>
<dependency>
<groupId>io.jsonwebtoken</groupId>
<artifactId>jjwt</artifactId>
<version>0.9.0</version>
</dependency>

項目配置文件中加入數據庫和 JPA等須要的配置

server.port=9991
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://121.196.XXX.XXX:3306/spring_security_jwt?useUnicode=true&characterEncoding=utf-8
spring.datasource.username=root
spring.datasource.password=XXXXXX
logging.level.org.springframework.security=info
spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true
spring.jackson.serialization.indent_output=true

建立用戶、角色實體

用戶實體 User：

/**
* @ www.codesheep.cn
* 20190312
*/
@Entity
public class User implements UserDetails {
@Id
@GeneratedValue
private Long id;
private String username;
private String password;
@ManyToMany(cascade = {CascadeType.REFRESH},fetch = FetchType.EAGER)
private List<Role> roles;
...
// 下面爲實現UserDetails而須要的重寫方法！
@Override
public Collection<? extends GrantedAuthority> getAuthorities() {
List<GrantedAuthority> authorities = new ArrayList<>();
for (Role role : roles) {
authorities.add( new SimpleGrantedAuthority( role.getName() ) );
}
return authorities;
}
...
}

此處所建立的 User類繼承了 Spring Security的 UserDetails接口，從而成爲了一個符合 Security安全的用戶，即經過繼承 UserDetails，便可實現 Security中相關的安全功能。

角色實體 Role：

/**
* @ www.codesheep.cn
* 20190312
*/
@Entity
public class Role {
@Id
@GeneratedValue
private Long id;
private String name;
... // 省略 getter和 setter
}

建立JWT工具類

主要用於對 JWT Token進行各項操做，好比生成Token、驗證Token、刷新Token等

/**
* @ www.codesheep.cn
* 20190312
*/
@Component
public class JwtTokenUtil implements Serializable {
private static final long serialVersionUID = -5625635588908941275L;
private static final String CLAIM_KEY_USERNAME = "sub";
private static final String CLAIM_KEY_CREATED = "created";
public String generateToken(UserDetails userDetails) {
...
}
String generateToken(Map<String, Object> claims) {
...
}
public String refreshToken(String token) {
...
}
public Boolean validateToken(String token, UserDetails userDetails) {
...
}
... // 省略部分工具函數
}

建立Token過濾器，用於每次外部對接口請求時的Token處理

/**
* @ www.codesheep.cn
* 20190312
*/
@Component
public class JwtTokenFilter extends OncePerRequestFilter {
@Autowired
private UserDetailsService userDetailsService;
@Autowired
private JwtTokenUtil jwtTokenUtil;
@Override
protected void doFilterInternal ( HttpServletRequest request, HttpServletResponse response, FilterChain chain) throws ServletException, IOException {
String authHeader = request.getHeader( Const.HEADER_STRING );
if (authHeader != null && authHeader.startsWith( Const.TOKEN_PREFIX )) {
final String authToken = authHeader.substring( Const.TOKEN_PREFIX.length() );
String username = jwtTokenUtil.getUsernameFromToken(authToken);
if (username != null && SecurityContextHolder.getContext().getAuthentication() == null) {
UserDetails userDetails = this.userDetailsService.loadUserByUsername(username);
if (jwtTokenUtil.validateToken(authToken, userDetails)) {
UsernamePasswordAuthenticationToken authentication = new UsernamePasswordAuthenticationToken(
userDetails, null, userDetails.getAuthorities());
authentication.setDetails(new WebAuthenticationDetailsSource().buildDetails(
request));
SecurityContextHolder.getContext().setAuthentication(authentication);
}
}
}
chain.doFilter(request, response);
}
}

Service業務編寫

主要包括用戶登陸和註冊兩個主要的業務

public interface AuthService {
User register( User userToAdd );
String login( String username, String password );
}

/**
* @ www.codesheep.cn
* 20190312
*/
@Service
public class AuthServiceImpl implements AuthService {
@Autowired
private AuthenticationManager authenticationManager;
@Autowired
private UserDetailsService userDetailsService;
@Autowired
private JwtTokenUtil jwtTokenUtil;
@Autowired
private UserRepository userRepository;
// 登陸
@Override
public String login( String username, String password ) {
UsernamePasswordAuthenticationToken upToken = new UsernamePasswordAuthenticationToken( username, password );
final Authentication authentication = authenticationManager.authenticate(upToken);
SecurityContextHolder.getContext().setAuthentication(authentication);
final UserDetails userDetails = userDetailsService.loadUserByUsername( username );
final String token = jwtTokenUtil.generateToken(userDetails);
return token;
}
// 註冊
@Override
public User register( User userToAdd ) {
final String username = userToAdd.getUsername();
if( userRepository.findByUsername(username)!=null ) {
return null;
}
BCryptPasswordEncoder encoder = new BCryptPasswordEncoder();
final String rawPassword = userToAdd.getPassword();
userToAdd.setPassword( encoder.encode(rawPassword) );
return userRepository.save(userToAdd);
}
}

Spring Security配置類編寫（很是重要）

這是一個高度綜合的配置類，主要是經過重寫 WebSecurityConfigurerAdapter 的部分 configure配置，來實現用戶自定義的部分。

/**
* @ www.codesheep.cn
* 20190312
*/
@Configuration
@EnableWebSecurity
@EnableGlobalMethodSecurity(prePostEnabled=true)
public class WebSecurityConfig extends WebSecurityConfigurerAdapter {
@Autowired
private UserService userService;
@Bean
public JwtTokenFilter authenticationTokenFilterBean() throws Exception {
return new JwtTokenFilter();
}
@Bean
public AuthenticationManager authenticationManagerBean() throws Exception {
return super.authenticationManagerBean();
}
@Override
protected void configure( AuthenticationManagerBuilder auth ) throws Exception {
auth.userDetailsService( userService ).passwordEncoder( new BCryptPasswordEncoder() );
}
@Override
protected void configure( HttpSecurity httpSecurity ) throws Exception {
httpSecurity.csrf().disable()
.sessionManagement().sessionCreationPolicy(SessionCreationPolicy.STATELESS).and()
.authorizeRequests()
.antMatchers(HttpMethod.OPTIONS, "/**").permitAll() // OPTIONS請求所有放行
.antMatchers(HttpMethod.POST, "/authentication/**").permitAll() //登陸和註冊的接口放行，其餘接口所有接受驗證
.antMatchers(HttpMethod.POST).authenticated()
.antMatchers(HttpMethod.PUT).authenticated()
.antMatchers(HttpMethod.DELETE).authenticated()
.antMatchers(HttpMethod.GET).authenticated();
// 使用前文自定義的 Token過濾器
httpSecurity
.addFilterBefore(authenticationTokenFilterBean(), UsernamePasswordAuthenticationFilter