SpringBoot中使用Springsecurity实现权限控制

末蓝、 2022-06-04 00:07 222阅读 0赞

本文转自:http://blog.csdn.net/u012702547/article/details/54319508 ——————————————————————- Spring Boot框架我们前面已经介绍了很多了，相信看了前面的博客的小伙伴对Spring Boot应该有一个大致的了解了吧，如果有小伙伴对Spring Boot尚不熟悉，可以先移步这里 [从SpringMVC到Spring Boot][SpringMVC_Spring Boot]，老司机请略过。OK，那我们今天要说的是Spring Boot中另外一个比较重要的东西，那就是Spring Security，这是一个专门针对基于Spring的项目的安全框架，它主要是利用了我们前文介绍过的的AOP（ [Spring基础配置][Spring]）来实现的。以前在Spring框架中使用Spring Security需要我们进行大量的XML配置，但是，Spring Boot在这里依然有惊喜带给我们，我们今天就一起来看看。  
毫无疑问，Spring Boot针对Spring Security也提供了自动配置的功能，这些默认的自动配置极大的简化了我们的开发工作，我们今天就来看看这个吧。

# 创建Project并添加相关依赖 #

Project的创建和前文一样，唯一要注意的地方就是创建的时候添加的依赖不同，如下图：  
![这里写图片描述][SouthEast]  
OK，创建成功之后添加相关依赖，数据库我这里使用MySql，所以添加MySql驱动，然后要添加Spring Security的支持，所以还要添加Spring Security的依赖，如下：

<dependency>
                <groupId>org.thymeleaf.extras</groupId>
                <artifactId>thymeleaf-extras-springsecurity4</artifactId>
            </dependency>
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>5.1.40</version>
            </dependency>
     
      
       1
       2
       3
       4
       5
       6
       7
       8
       9

# 配置application.properties #

这个东东的配置还是和我们上文说到的是一样的，这里也没啥好说的，有问题的小伙伴翻看前文([初识在Spring Boot中使用JPA][Spring Boot_JPA])：

spring.datasource.driver-class-name=com.mysql.jdbc.Driver
    spring.datasource.url=jdbc:mysql://localhost:3306/sang?useUnicode=true&characterEncoding=utf-8
    spring.datasource.username=root
    spring.datasource.password=sang
    logging.level.org.springframework.security=info
    spring.thymeleaf.cache=false
    spring.jpa.hibernate.ddl-auto=update
    spring.jpa.show-sql=true
     
      
       1
       2
       3
       4
       5
       6
       7
       8

# 定义用户和角色 #

我们这里使用JPA来定义用户和角色，用户和角色都存储在数据库中，我们直接通过在数据库中查询然后来使用。

## 定义角色 ##

我们的角色实体类和表都很简单，就两个字段，一个id，一个name属性表示角色的名称，实体类如下;

@Entity
    public class SysRole { 
        @Id
        @GeneratedValue
        private Long id;
        private String name;
    
    
        public Long getId() {
            return id;
        }
    
        public void setId(Long id) {
            this.id = id;
        }
    
        public String getName() {
            return name;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    }
     
      
       1
       2
       3
       4
       5
       6
       7
       8
       9
       10
       11
       12
       13
       14
       15
       16
       17
       18
       19
       20
       21
       22
       23
       24

OK，简简单单就这两个属性。

## 定义用户 ##

我们在定义用户的时候需要实现UserDetails接口，这样我们的用户实体即为Spring Security所使用的用户，定义好用户之后，我们还要配置用户和角色之间的多对多关系，正常情况下，角色和权限是两回事，所以我们还需要重写getAuthorities方法，将用户的角色和权限关联起来，代码如下：

@Entity
    public class SysUser implements UserDetails { 
        @Id
        @GeneratedValue
        private Long id;
        private String username;
        private String password;
    
        @ManyToMany(cascade = {CascadeType.REFRESH},fetch = FetchType.EAGER)
        private List<SysRole> roles;
    
        public Long getId() {
            return id;
        }
    
        public void setId(Long id) {
            this.id = id;
        }
    
        public void setUsername(String username) {
            this.username = username;
        }
    
        public void setPassword(String password) {
            this.password = password;
        }
    
        public List<SysRole> getRoles() {
            return roles;
        }
    
        public void setRoles(List<SysRole> roles) {
            this.roles = roles;
        }
    
        @Override
        public Collection<? extends GrantedAuthority> getAuthorities() {
            List<GrantedAuthority> auths = new ArrayList<>();
            List<SysRole> roles = this.getRoles();
            for (SysRole role : roles) {
                auths.add(new SimpleGrantedAuthority(role.getName()));
            }
            return auths;
        }
    
        @Override
        public String getPassword() {
            return this.password;
        }
    
        @Override
        public String getUsername() {
            return this.username;
        }
    
        @Override
        public boolean isAccountNonExpired() {
            return true;
        }
    
        @Override
        public boolean isAccountNonLocked() {
            return true;
        }
    
        @Override
        public boolean isCredentialsNonExpired() {
            return true;
        }
    
        @Override
        public boolean isEnabled() {
            return true;
        }
    }
    
     
      
       1
       2
       3
       4
       5
       6
       7
       8
       9
       10
       11
       12
       13
       14
       15
       16
       17
       18
       19
       20
       21
       22
       23
       24
       25
       26
       27
       28
       29
       30
       31
       32
       33
       34
       35
       36
       37
       38
       39
       40
       41
       42
       43
       44
       45
       46
       47
       48
       49
       50
       51
       52
       53
       54
       55
       56
       57
       58
       59
       60
       61
       62
       63
       64
       65
       66
       67
       68
       69
       70
       71
       72
       73
       74
       75
       76

OK，经过上面两个步骤之后我们的用户就和角色关联起来了，这个时候运行Project就会在数据库中自动帮我们生成三张表，用户表、角色表和两者的关联表，如下：  
![这里写图片描述][SouthEast 1]

## 预设数据 ##

我们先在表中定义好几个角色和用户，方便我们后边做测试用，OK，预设数据的话，那我们执行如下几行数据插入代码：

insert into `sys_role`(`id`,`name`) values (1,'ROLE_ADMIN'),(2,'ROLE_USER');
    
    insert into `sys_user`(`id`,`password`,`username`) values (1,'root','root'),(2,'sang','sang');
    
    insert into `sys_user_roles`(`sys_user_id`,`roles_id`) values (1,1),(2,2);
    
     
      
       1
       2
       3
       4
       5
       6

我们向数据库中插入两个用户两个角色，再将这两个用户两个角色关联起来即可。

# 创建传值对象 #

数据创建成功之后，在客户端请求网页的时候我们需要有一个实体类用来向客户端传递消息，OK，那我们创建一个MSG对象：

public class Msg {
        private String title;
        private String content;
        private String extraInfo;
    
        public Msg() {
        }
    
        public String getTitle() {
            return title;
        }
    
        public void setTitle(String title) {
            this.title = title;
        }
    
        public String getContent() {
            return content;
        }
    
        public void setContent(String content) {
            this.content = content;
        }
    
        public String getExtraInfo() {
            return extraInfo;
        }
    
        public void setExtraInfo(String extraInfo) {
            this.extraInfo = extraInfo;
        }
    
        public Msg(String title, String content, String extraInfo) {
            this.title = title;
            this.content = content;
            this.extraInfo = extraInfo;
        }
    }
     
      
       1
       2
       3
       4
       5
       6
       7
       8
       9
       10
       11
       12
       13
       14
       15
       16
       17
       18
       19
       20
       21
       22
       23
       24
       25
       26
       27
       28
       29
       30
       31
       32
       33
       34
       35
       36
       37
       38

这就是一个普通的类，没什么好说的。

# 创建数据访问接口 #

public interface SysUserRepository extends JpaRepository<SysUser, Long> { 
        SysUser findByUsername(String username);
    }
     
      
       1
       2
       3

这个也是写了n多遍的东西了，不赘述，关于这里如果小伙伴有疑问可以参考这里([初识在Spring Boot中使用JPA][Spring Boot_JPA])。需要注意的是这里只需要一个根据用户名查询出用户的方法即可，不需要通过用户名和密码去查询。

# 自定义UserDetailsService #

自定义UserDetailsService，实现相应的接口，如下：

public class CustomUserService implements UserDetailsService { 
        @Autowired
        SysUserRepository userRepository;
        @Override
        public UserDetails loadUserByUsername(String s) throws UsernameNotFoundException {
            SysUser user = userRepository.findByUsername(s);
            if (user == null) {
                throw new UsernameNotFoundException("用户名不存在");
            }
            System.out.println("s:"+s);
            System.out.println("username:"+user.getUsername()+";password:"+user.getPassword());
            return user;
        }
    }
     
      
       1
       2
       3
       4
       5
       6
       7
       8
       9
       10
       11
       12
       13
       14

首先这里我们需要重写UserDetailsService接口，然后实现该接口中的loadUserByUsername方法，通过该方法查询到对应的用户，这里之所以要实现UserDetailsService接口，是因为在Spring Security中我们配置相关参数需要UserDetailsService类型的数据。

# SpringMVC配置 #

@Configuration
    public class WebMvcConfig extends WebMvcConfigurerAdapter { 
        @Override
        public void addViewControllers(ViewControllerRegistry registry) {
            registry.addViewController("/login").setViewName("login");
        }
    }
     
      
       1
       2
       3
       4
       5
       6
       7

当用户访问login时跳转到login.html页面。

# 配置Spring Security #

@Configuration
    public class WebSecurityConfig extends WebSecurityConfigurerAdapter { 
        @Bean
        UserDetailsService customUserService() {
            return new CustomUserService();
        }
    
        @Override
        protected void configure(AuthenticationManagerBuilder auth) throws Exception {
            auth.userDetailsService(customUserService());
        }
    
        @Override
        protected void configure(HttpSecurity http) throws Exception {
            http.authorizeRequests()
                    .anyRequest().authenticated()
                    .and().formLogin().loginPage("/login").failureUrl("/login?error").permitAll().and()
                    .logout().permitAll();
        }
    }
     
      
       1
       2
       3
       4
       5
       6
       7
       8
       9
       10
       11
       12
       13
       14
       15
       16
       17
       18
       19
       20

OK ，关于这个配置我要多说两句：

> 1.首先当我们要自定义Spring Security的时候我们需要继承自WebSecurityConfigurerAdapter来完成，相关配置重写对应 方法即可。  
> 2.我们在这里注册CustomUserService的Bean，然后通过重写configure方法添加我们自定义的认证方式。  
> 3.在configure(HttpSecurity http)方法中，我们设置了登录页面，而且登录页面任何人都可以访问，然后设置了登录失败地址，也设置了注销请求，注销请求也是任何人都可以访问的。  
> 4.permitAll表示该请求任何人都可以访问，`.anyRequest().authenticated()`,表示其他的请求都必须要有权限认证。  
> 5.这里我们可以通过匹配器来匹配路径，比如antMatchers方法，假设我要管理员才可以访问admin文件夹下的内容，我可以这样来写：`.antMatchers("/admin/**").hasRole("ROLE_ADMIN")`，也可以设置admin文件夹下的文件可以有多个角色来访问，写法如下：`.antMatchers("/admin/**").hasAnyRole("ROLE_ADMIN","ROLE_USER")`  
> 6.可以通过hasIpAddress来指定某一个ip可以访问该资源,假设只允许访问ip为210.210.210.210的请求获取admin下的资源，写法如下`.antMatchers("/admin/**").hasIpAddress("210.210.210.210")`  
> 7.更多的权限控制方式参看下表：  
> ![这里写图片描述][SouthEast 2]  
> 8.这里我们还可以做更多的配置，参考如下代码：

http.authorizeRequests()
                    .anyRequest().authenticated()
                    .and().formLogin().loginPage("/login")
                    //设置默认登录成功跳转页面
                    .defaultSuccessUrl("/index").failureUrl("/login?error").permitAll()
                    .and()
                    //开启cookie保存用户数据
                    .rememberMe()
                    //设置cookie有效期
                    .tokenValiditySeconds(60 * 60 * 24 * 7)
                    //设置cookie的私钥
                    .key("")
                    .and()
                    .logout()
                    //默认注销行为为logout，可以通过下面的方式来修改
                    .logoutUrl("/custom-logout")
                    //设置注销成功后跳转页面，默认是跳转到登录页面
                    .logoutSuccessUrl("")
                    .permitAll();
     
      
       1
       2
       3
       4
       5
       6
       7
       8
       9
       10
       11
       12
       13
       14
       15
       16
       17
       18
       19

OK，这里算是核心了，多说两句。

# 创建登录页面 #

在template文件夹中创建login.html页面，内容如下：

<!DOCTYPE html>
    <html lang="en" xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8"/>
        <title>登录</title>
        <link rel="stylesheet" th:href="@{css/bootstrap.min.css}"/>
        <link rel="stylesheet" th:href="@{css/signin.css}"/>
        <style type="text/css"> body { padding-top: 50px; } .starter-template { padding: 40px 15px; text-align: center; } </style>
    </head>
    <body>
    <nav class="navbar navbar-inverse navbar-fixed-top">
        <div class="container">
            <div class="navbar-header">
                <a class="navbar-brand" href="#">Spring Security演示</a>
            </div>
            <div id="navbar" class="collapse navbar-collapse">
                <ul class="nav navbar-nav">
                    <li><a th:href="@{/}">首页</a></li>
                    <li><a th:href="@{http://www.baidu.com}">百度</a></li>
                </ul>
            </div>
        </div>
    </nav>
    <div class="container">
        <div class="starter-template">
            <p th:if="${param.logout}" class="bg-warning">已注销</p>
            <p th:if="${param.error}" class="bg-danger">有错误，请重试</p>
            <h2>使用账号密码登录</h2>
            <form class="form-signin" role="form" name="form" th:action="@{/login}" action="/login" method="post">
                <div class="form-group">
                    <label for="username">账号</label>
                    <input type="text" class="form-control" name="username" value="" placeholder="账号"/>
                </div>
                <div class="form-group">
                    <label for="password">密码</label>
                    <input type="password" class="form-control" name="password" placeholder="密码"/>
                </div>
                <input type="submit" id="login" value="Login" class="btn btn-primary"/>
            </form>
        </div>
    </div>
    </body>
    </html>
     
      
       1
       2
       3
       4
       5
       6
       7
       8
       9
       10
       11
       12
       13
       14
       15
       16
       17
       18
       19
       20
       21
       22
       23
       24
       25
       26
       27
       28
       29
       30
       31
       32
       33
       34
       35
       36
       37
       38
       39
       40
       41
       42
       43
       44
       45
       46
       47
       48
       49
       50
       51
       52

这里就是一个普通的html页面，用到了thymeleaf模板引擎（thymeleaf可以参考这两篇文章[使用Spring Boot开发Web项目][Spring Boot_Web]/[使用Spring Boot开发Web项目(二)之添加HTTPS支持][Spring Boot_Web_HTTPS]），

# 创建登录成功后跳转页面 #

<!DOCTYPE html>
    <html lang="en" xmlns:th="http://www.thymeleaf.org" xmlns:sec="http://www.thymeleaf.org/thymeleaf-extras-springsecurity4">
    <head>
        <meta charset="UTF-8"/>
        <title sec:authentication="name"></title>
        <link rel="stylesheet" th:href="@{css/bootstrap.min.css}"/>
        <style type="text/css"> body { padding-top: 50px; } .starter-template { padding: 40px 15px; text-align: center; } </style>
    </head>
    <body>
    <nav class="navbar navbar-inverse navbar-fixed-top">
        <div class="container">
            <div class="navbar-header">
                <a class="navbar-brand" href="#">Spring Security演示</a>
            </div>
            <div id="navbar" class="collapse navbar-collapse">
                <ul class="nav navbar-nav">
                    <li><a th:href="@{/}">首页</a></li>
                    <li><a th:href="@{http://www.baidu.com}">百度</a></li>
                </ul>
            </div>
        </div>
    </nav>
    <div class="container">
        <div class="starter-template">
            <h1 th:text="${msg.title}"></h1>
            <p class="bg-primary" th:text="${msg.content}"></p>
            <div sec:authorize="hasRole('ROLE_ADMIN')">
                <p class="bg-info" th:text="${msg.extraInfo}"></p>
            </div>
            <div sec:authorize="hasRole('ROLE_USER')">
                <p class="bg-info">无更多显示信息</p>
            </div>
            <form th:action="@{/logout}" method="post">
                <input type="submit" class="btn btn-primary" value="注销"/>
            </form>
        </div>
    </div>
    </body>
    </html>
     
      
       1
       2
       3
       4
       5
       6
       7
       8
       9
       10
       11
       12
       13
       14
       15
       16
       17
       18
       19
       20
       21
       22
       23
       24
       25
       26
       27
       28
       29
       30
       31
       32
       33
       34
       35
       36
       37
       38
       39
       40
       41
       42
       43
       44
       45
       46
       47
       48
       49

这里有如下几个问题需要说明：

> 1.在html标签中我们引入的Spring Security  
> 2.通过sec:authentication=”name”我们可以获取当前用户名  
> 3.`sec:authorize="hasRole('ROLE_ADMIN')`表示当前用户角色为ROLE\_ADMIN的话显示里边的内容  
> 4.`sec:authorize="hasRole('ROLE_USER')`表示当前用户角色为ROLE\_USER的话显示该DIV里边的内容

# 添加控制器 #

@Controller
    public class HomeController { 
        @RequestMapping("/")
        public String index(Model model) {
            Msg msg = new Msg("测试标题", "测试内容", "额外信息，只对管理员显示");
            model.addAttribute("msg", msg);
            return "index";
        }
    }
     
      
       1
       2
       3
       4
       5
       6
       7
       8
       9

# 测试 #

## 首页如下： ##

访问[http://localhost:8080/][http_localhost_8080]自动跳转到[http://localhost:8080/login][http_localhost_8080_login]  
![这里写图片描述][SouthEast 3]

## 登录出错 ##

输入错误的账号密码进行登录，结果如下：  
![这里写图片描述][SouthEast 4]

## 管理员登录 ##

使用管理员帐号密码登录，结果如下：  
![这里写图片描述][SouthEast 5]

## 普通用户登录 ##

使用普通用户帐号密码登录，结果如下：  
![这里写图片描述][SouthEast 6]

## 注销 ##

点击注销按钮，结果如下：  
![这里写图片描述][SouthEast 7]

OK，以上就是对Spring Security的一个简单介绍，是不是比自己通过过滤器、拦截器神马的来弄简单多了。

本文案例下载：  
本文案例GitHub地址[https://github.com/lenve/JavaEETest/tree/master/Test26-Security][https_github.com_lenve_JavaEETest_tree_master_Test26-Security].

更多Spring Boot资料请移步这里[从SpringMVC到Spring Boot][SpringMVC_Spring Boot]。

以上。

参考资料：  
《JavaEE开发的颠覆者 Spring Boot实战》第九章

(function () \{  ('pre.prettyprint code').each(function () \{ var lines =  (this).text().split(′\\n′).length;var numbering = $('

*  ').addClass('pre-numbering').hide();  (this).addClass(′has−numbering′).parent().append(numbering); for (i = 1; i

[SpringMVC_Spring Boot]: https://github.com/lenve/JavaEETest
[Spring]: http://blog.csdn.net/u012702547/article/details/53587684
[SouthEast]: /images/20220604/fddf16ee733b484296eafee402aff925.png
[Spring Boot_JPA]: http://blog.csdn.net/u012702547/article/details/53946440
[SouthEast 1]: /images/20220604/7a1c7f2586784ff5add589c3b6c18ff1.png
[SouthEast 2]: /images/20220604/29adaef1c08b498abf60e5f25cf0b4c2.png
[Spring Boot_Web]: http://blog.csdn.net/u012702547/article/details/53784992
[Spring Boot_Web_HTTPS]: http://blog.csdn.net/u012702547/article/details/53790722
[http_localhost_8080]: http://localhost:8080/
[http_localhost_8080_login]: http://localhost:8080/login
[SouthEast 3]: /images/20220604/a8617ecc5f58430b9f5b29f29da42dd9.png
[SouthEast 4]: /images/20220604/03a9e333b490482fb599196bd2887bdf.png
[SouthEast 5]: /images/20220604/9820b71f0f4b4378a7f1ffb967bca477.png
[SouthEast 6]: /images/20220604/ce0a7d74f5c34a4bb08cd5f56f1fdeed.png
[SouthEast 7]: /images/20220604/673280a493d0494fa736b0a6d64ce671.png
[https_github.com_lenve_JavaEETest_tree_master_Test26-Security]: https://github.com/lenve/JavaEETest/tree/master/Test26-Security