SpringSecurity入门案例——基本功能讲解

ゞ浴缸里的玫瑰 2024-03-24 23:51 63阅读 0赞

## SpringSecurity入门案例——基本功能讲解 ##

简介：本文讲解，SpringSecurity的快速入门案例，主要讲解基本功能，其他拦截器，与jwt的结合在后面的文章中讲解。

项目代码地址：https://gitee.com/geek-li-hua/code-in-blog.git  
![在这里插入图片描述][4631b89804ea444fa8573d8b94a68f21.png]

### 项目实现 ###

#### 项目准备 ####

##### 导入依赖 #####

这些是这个项目需要的依赖

*  Spring Boot Starter JDBC
 *  Project Lombok
 *  MySQL Connector/J
 *  mybatis-plus-boot-starter
 *  mybatis-plus-generator
 *  spring-boot-starter-security

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-jdbc</artifactId>
            </dependency>
    
            
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <scope>provided</scope>
            </dependency>
    
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>8.0.32</version>
            </dependency>
            
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>3.5.2</version>
            </dependency>
    
            
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-generator</artifactId>
                <version>3.5.3</version>
            </dependency>
    
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-security</artifactId>
            </dependency>

*  完整的pom.xml

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.7.15</version>
            <relativePath/> 
        </parent>
        <groupId>com.example</groupId>
        <artifactId>springsecurity-back-demo</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>springsecurity-back-demo</name>
        <description>springsecurity-back-demo</description>
        <properties>
            <java.version>1.8</java.version>
        </properties>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
            </dependency>
    
            <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.springframework.boot</groupId>
                <artifactId>spring-boot-starter-jdbc</artifactId>
            </dependency>
    
            
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <scope>provided</scope>
            </dependency>
    
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>8.0.32</version>
            </dependency>
            
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>3.5.2</version>
            </dependency>
    
            
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-generator</artifactId>
                <version>3.5.3</version>
            </dependency>
    
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-security</artifactId>
            </dependency>
    
            
            <dependency>
                <groupId>io.jsonwebtoken</groupId>
                <artifactId>jjwt-api</artifactId>
                <version>0.11.2</version>
            </dependency>
    
            
            <dependency>
                <groupId>io.jsonwebtoken</groupId>
                <artifactId>jjwt-impl</artifactId>
                <version>0.11.2</version>
                <scope>runtime</scope>
            </dependency>
    
            
            <dependency>
                <groupId>io.jsonwebtoken</groupId>
                <artifactId>jjwt-jackson</artifactId>
                <version>0.11.2</version>
                <scope>runtime</scope>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    </project>

##### 配置文件 #####

spring.port = 8080
    spring.datasource.username=root
    spring.datasource.password=123456
    spring.datasource.url=jdbc:mysql://localhost:3306/db?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf-8
    spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

##### springsecurity登录 #####

当我们启动项目的时候，会出现一个密码，这是因为加入了springsecurity的依赖导致的。  
![在这里插入图片描述][ccf5e573a5e640e5b015dc44d182ed4c.png]

当我们通过一个网页，访问其中一个端口时  
![在这里插入图片描述][64542b65955240f3920a4f3bac37ff39.png]  
会发现需要输入账号和密码，其中账号是`user`，密码是上面生成的，只有登录之后，我们才可以进行相关的调试。  
![在这里插入图片描述][bcdde40c4d1c4ad88d9bf5c29c5409b4.png]  
![在这里插入图片描述][1c7ed986d6f74cabaabc8941f4718fe0.png]  
![在这里插入图片描述][dbf6cf5e7ef14e2b961636dfb67cb7d5.png]

##### 实现加密 #####

*  我们需要使用到一个类

import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
    import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
    import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
    import org.springframework.security.crypto.password.PasswordEncoder;
    
    
    @Configuration
    @EnableWebSecurity
    public class SecurityConfig extends WebSecurityConfigurerAdapter {
        
    
        @Bean
        public PasswordEncoder passwordEncoder() {
        
    
            return new BCryptPasswordEncoder();
        }
    }

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

*  我们在测试类中演示它的使用

对密码进行加密

@Test
        void contextLoads() {
        
            BCryptPasswordEncoder passwordEncoder = new BCryptPasswordEncoder();
            System.out.println(passwordEncoder.encode("123456"));
        }

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

对于同一字符串，每次加密的结果可能也不一样。  
![在这里插入图片描述][f04bc03a5f194dfc82fed40fe6c985a5.png]

*  可以通过matchs方法检验，加密之后与之前是否匹配

可以通过结果看出来的是，虽然对于同一密码每次的加密都不一样，但是，都是可以匹配的。

@Test
        void contextLoads() {
        
            BCryptPasswordEncoder passwordEncoder = new BCryptPasswordEncoder();
            System.out.println(passwordEncoder.encode("123456"));
            System.out.println(passwordEncoder.matches("123456", "$2a$10$9dBGJIqaejarMaPSJZfzZumyyT4gjY8etzgp3warVCJw2GR6USbtC")); // true
            System.out.println(passwordEncoder.encode("123456"));
            System.out.println(passwordEncoder.matches("123456", "$2a$10$WPyb8qBc7DfPSD6l6nVnauiexFQ/MTF6nExLZid4Li5RINhBfr4pC")); // true
            System.out.println(passwordEncoder.encode("123456"));
            System.out.println(passwordEncoder.matches("123456", "$2a$10$U0M5Xap/aKo7ZBLiZEvfluZH8FQT10yD2PwInhyU/7W2bSXNoBcba")); // true
            System.out.println(passwordEncoder.matches("1", "$2a$10$U0M5Xap/aKo7ZBLiZEvfluZH8FQT10yD2PwInhyU/7W2bSXNoBcba")); // false
        }

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

##### 让SpringSecurity的登录账号和密码与自己的数据中的用户的信息匹配 #####

*  实现一个`UserDetailsServiceImpl`类

@Service
    public class UserDetailsServiceImpl implements UserDetailsService {
        
        @Autowired
        private UserMapper userMapper;
        @Override
        public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
        
            // 根据用户名查询用户信息
            QueryWrapper<User> queryWrapper = new QueryWrapper<>();
            queryWrapper.eq("username", username);
            User user = userMapper.selectOne(queryWrapper);
            // 判断用户是否存在
            if (user == null) {
        
                throw new UsernameNotFoundException("用户名不存在");
            }
            return new UserDetailsImpl(user);
        }
    }

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

*  再实现一个`UserDetailsImpl`类，实现`UserDetails`里面的方法，并且重写，按照我下面的这样

@Data
    @AllArgsConstructor
    @NoArgsConstructor
    public class UserDetailsImpl implements UserDetails {
        
        private User user;
    
        @Override
        public Collection<? extends GrantedAuthority> getAuthorities() {
        
            // 返回拥有的权限
            return null;
        }
    
        @Override
        public String getPassword() {
        
            // 返回密码
            return user.getPassword();
        }
    
        @Override
        public String getUsername() {
        
            // 返回用户名
            return user.getUsername();
        }
    
        @Override
        public boolean isAccountNonExpired() {
        
            // 返回账户是否未过期
            return true;
        }
    
        @Override
        public boolean isAccountNonLocked() {
        
            // 返回账户是否未锁定
            return true;
        }
    
        @Override
        public boolean isCredentialsNonExpired() {
        
            // 返回凭据是否未过期
            return true;
        }
    
        @Override
        public boolean isEnabled() {
        
            // 返回账户是否可用
            return true;
        }
    }

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

*  当我们上面都配置正确之后，我们再次运行的时候，就不会生成一个随机密码了  
    ![在这里插入图片描述][b3f054c7d4b846b19c54edd1c77be627.png]
 *  配置完上面的之后，我们就可以用数据库里面的账号，进行登录了。  
    如果数据库里面存的是没有加密的数据，可以加上`{noop}`，这样就可以不用存密文。

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

两个用户使用`123456`都可以登录，第二个用户存储的是`123456`加密之后的密文  
![在这里插入图片描述][eb554f832c80407497c12649cce13f50.png]

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

*  实现下面的方法，特别是`addUser`的方法，对用户进行添加，以后注册就是这个原理

@RestController
    @RequestMapping("/user")
    public class UserController {
        
    
        @Autowired
        IUserService userService;
    
        /**
         * 查询所有用户
         */
        @GetMapping("/all/")
        public List<User> getAll() {
        
            return userService.list();
        }
    
        /**
         * 查询单个用户
         */
        @GetMapping("/{userId}/")
        public User getUser(@PathVariable int userId) {
        
            QueryWrapper<User> queryWrapper = new QueryWrapper<>();
            queryWrapper.eq("id",userId);
    
            return userService.getOne(queryWrapper);
        }
    
        /**
         * 添加某个用户 直接输入 id name password
         * @param userId
         * @param username
         * @param password
         * @return Add User Sucessfully
         */
        @GetMapping("/add/{userId}/{username}/{password}/")
        public String addUser(
                @PathVariable int userId,
                @PathVariable String username,
                @PathVariable String password) {
        
            PasswordEncoder passwordEncoder = new BCryptPasswordEncoder();
            String encodedPassword = passwordEncoder.encode(password);
            User user = new User(userId, username, encodedPassword);
            userService.save(user);
            return "Add User Successfully";
        }
    
    
        /**
         * 删除某个用户，直接输入 id
         * @param userId
         * @return Delete User Successfully
         */
        @GetMapping("/delete/{userId}/")
        public String deleteUser(@PathVariable int userId) {
        
            userService.removeById(userId);
            return "Delete User Successfully";
        }
    }

![在这里插入图片描述][6e8e0a0d03e04574999f4f9b91fb31bb.png]  
![在这里插入图片描述][57eb66b2626c454caac1bf1c36084119.png]  
![在这里插入图片描述][05a4e24b5f11402f82de3cf3806a45f1.png]

[4631b89804ea444fa8573d8b94a68f21.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/eace4fbe40784e3bb5b73ff3e1a28d10.png
[ccf5e573a5e640e5b015dc44d182ed4c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/481d7e61e9134bc9933df839e7f27bfd.png
[64542b65955240f3920a4f3bac37ff39.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/e2791b72875245ebbb56d91d02c867b9.png
[bcdde40c4d1c4ad88d9bf5c29c5409b4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/cc6d433cb3ba4125a912f5eb852b0dbb.png
[1c7ed986d6f74cabaabc8941f4718fe0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/f7de28260a7b4237a96dcd2e7c2d5068.png
[dbf6cf5e7ef14e2b961636dfb67cb7d5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/5704b14087874c5eb1b8f4fbbc55de5b.png
[655cf7d767f54a2fb2a6334b8ee0b21f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/40f2b6400cc84ea8ae0be844c47c17cd.png
[8169fef5936549c398ab4caee94eabb8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/2a9010ae4ad14f67949ec73c119c39a3.png
[f04bc03a5f194dfc82fed40fe6c985a5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/d5a001dfc15a44a49e71b84fb0993ffe.png
[71a40fbb544940788f0be88f8d69af4f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/7484a5b28e2646eb900123444bf69b1a.png
[44ef1e36e79d4bb19ad8d243ad2ca1b2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/9d448af2146a44fb871f617028c949c1.png
[b2f08afc178c47bdbc81555dd5891be2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/f9d3153735934d9e8a17d551d612e76d.png
[b3f054c7d4b846b19c54edd1c77be627.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/02b16eb47a8d405c9c928afce2d0a78d.png
[58c55b6a50e14276a0815c0584b39477.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/0ecd55a08b59485084c75ccc0ea18d17.png
[eb554f832c80407497c12649cce13f50.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/80fda01e36614fb3937c8b27bd8113cb.png
[0bfd9d8434964612adbb8fdf57f6dd71.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/0f695b10651144a3a46d24c2a8a6bbd2.png
[6e8e0a0d03e04574999f4f9b91fb31bb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/b0e2b7f8ac8a410b904229c12ca71b6b.png
[57eb66b2626c454caac1bf1c36084119.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/a03921de4abb4fabad514905ffd74652.png
[05a4e24b5f11402f82de3cf3806a45f1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/46870d36f5e148c88bbbdf4aa08e9f81.png