SpringBoot 集成 Shiro 极简教程（实战版）

转x33g5p2x  于2021-09-29 转载在 Spring  
字(14.2k)|赞(0)|评价(0)|浏览(980)

来源：juejin.cn/post/6844903887871148039

1. 前言

Apache Shiro是一个功能强大且易于使用的Java安全框架，提供了认证，授权，加密，和会话管理。

Shiro有三大核心组件：

Subject： 即当前用户，在权限管理的应用程序里往往需要知道谁能够操作什么，谁拥有操作该程序的权利，shiro中则需要通过Subject来提供基础的当前用户信息，Subject 不仅仅代表某个用户，与当前应用交互的任何东西都是Subject，如网络爬虫等。所有的Subject都要绑定到SecurityManager上，与Subject的交互实际上是被转换为与SecurityManager的交互。
*
SecurityManager： 即所有Subject的管理者，这是Shiro框架的核心组件，可以把他看做是一个Shiro框架的全局管理组件，用于调度各种Shiro框架的服务。作用类似于SpringMVC中的DispatcherServlet，用于拦截所有请求并进行处理。
*
Realm： Realm是用户的信息认证器和用户的权限人证器，我们需要自己来实现Realm来自定义的管理我们自己系统内部的权限规则。SecurityManager要验证用户，需要从Realm中获取用户。可以把Realm看做是数据源。

2. 数据库设计

2.1 User(用户)

  1. SET NAMES utf8mb4;
  2. SET FOREIGN_KEY_CHECKS = 0;
  4. -- ----------------------------
  5. -- Table structure for user
  6. -- ----------------------------
  7. DROP TABLE IF EXISTS `user`;
  8. CREATE TABLE `user`  (
  9.   `id` bigint(20) NOT NULL AUTO_INCREMENT,
  10.   `password` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
  11.   `username` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
  12.   `account` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
  13.   PRIMARY KEY (`id`) USING BTREE
  14. ) ENGINE = MyISAM AUTO_INCREMENT = 4 CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = Dynamic;
  16. -- ----------------------------
  17. -- Records of user
  18. -- ----------------------------
  19. INSERT INTO `user` VALUES (1, 'root', '超级用户', 'root');
  20. INSERT INTO `user` VALUES (2, 'user', '普通用户', 'user');
  21. INSERT INTO `user` VALUES (3, 'vip', 'VIP用户', 'vip');
  23. SET FOREIGN_KEY_CHECKS = 1;

2.2 Role(角色)

  1. SET NAMES utf8mb4;
  2. SET FOREIGN_KEY_CHECKS = 0;
  4. -- ----------------------------
  5. -- Table structure for role
  6. -- ----------------------------
  7. DROP TABLE IF EXISTS `role`;
  8. CREATE TABLE `role`  (
  9.   `id` int(11) NOT NULL AUTO_INCREMENT,
  10.   `role` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
  11.   `desc` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
  12.   PRIMARY KEY (`id`) USING BTREE
  13. ) ENGINE = MyISAM AUTO_INCREMENT = 4 CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = Dynamic;
  15. -- ----------------------------
  16. -- Records of role
  17. -- ----------------------------
  18. INSERT INTO `role` VALUES (1, 'admin', '超级管理员');
  19. INSERT INTO `role` VALUES (2, 'user', '普通用户');
  20. INSERT INTO `role` VALUES (3, 'vip_user', 'VIP用户');
  22. SET FOREIGN_KEY_CHECKS = 1;

2.3 Permission(权限)

  1. SET NAMES utf8mb4;
  2. SET FOREIGN_KEY_CHECKS = 0;
  4. -- ----------------------------
  5. -- Table structure for permission
  6. -- ----------------------------
  7. DROP TABLE IF EXISTS `permission`;
  8. CREATE TABLE `permission`  (
  9.   `id` int(11) NOT NULL AUTO_INCREMENT,
  10.   `permission` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '权限名称',
  11.   `desc` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '权限描述',
  12.   PRIMARY KEY (`id`) USING BTREE
  13. ) ENGINE = MyISAM AUTO_INCREMENT = 5 CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = Dynamic;
  15. -- ----------------------------
  16. -- Records of permission
  17. -- ----------------------------
  18. INSERT INTO `permission` VALUES (1, 'add', '增加');
  19. INSERT INTO `permission` VALUES (2, 'update', '更新');
  20. INSERT INTO `permission` VALUES (3, 'select', '查看');
  21. INSERT INTO `permission` VALUES (4, 'delete', '删除');
  23. SET FOREIGN_KEY_CHECKS = 1;

2.4 User_Role(用户-角色)

  1. SET NAMES utf8mb4;
  2. SET FOREIGN_KEY_CHECKS = 0;
  4. -- ----------------------------
  5. -- Table structure for user_role
  6. -- ----------------------------
  7. DROP TABLE IF EXISTS `user_role`;
  8. CREATE TABLE `user_role`  (
  9.   `id` int(11) NOT NULL AUTO_INCREMENT,
  10.   `user_id` int(11) NULL DEFAULT NULL,
  11.   `role_id` int(11) NULL DEFAULT NULL,
  12.   PRIMARY KEY (`id`) USING BTREE
  13. ) ENGINE = MyISAM AUTO_INCREMENT = 4 CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = Fixed;
  15. -- ----------------------------
  16. -- Records of user_role
  17. -- ----------------------------
  18. INSERT INTO `user_role` VALUES (1, 1, 1);
  19. INSERT INTO `user_role` VALUES (2, 2, 2);
  20. INSERT INTO `user_role` VALUES (3, 3, 3);
  22. SET FOREIGN_KEY_CHECKS = 1;

2.5 Role_Permission(角色-权限)

  1. SET NAMES utf8mb4;
  2. SET FOREIGN_KEY_CHECKS = 0;
  4. -- ----------------------------
  5. -- Table structure for role_permission
  6. -- ----------------------------
  7. DROP TABLE IF EXISTS `role_permission`;
  8. CREATE TABLE `role_permission`  (
  9.   `id` int(11) NOT NULL AUTO_INCREMENT,
  10.   `role_id` int(11) NULL DEFAULT NULL,
  11.   `permission_id` int(255) NULL DEFAULT NULL,
  12.   PRIMARY KEY (`id`) USING BTREE
  13. ) ENGINE = MyISAM AUTO_INCREMENT = 9 CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = Fixed;
  15. -- ----------------------------
  16. -- Records of role_permission
  17. -- ----------------------------
  18. INSERT INTO `role_permission` VALUES (1, 1, 1);
  19. INSERT INTO `role_permission` VALUES (2, 1, 2);
  20. INSERT INTO `role_permission` VALUES (3, 1, 3);
  21. INSERT INTO `role_permission` VALUES (4, 1, 4);
  22. INSERT INTO `role_permission` VALUES (5, 2, 3);
  23. INSERT INTO `role_permission` VALUES (6, 3, 3);
  24. INSERT INTO `role_permission` VALUES (7, 3, 2);
  25. INSERT INTO `role_permission` VALUES (8, 2, 1);
  27. SET FOREIGN_KEY_CHECKS = 1;

3. 项目结构

4. 前期准备

4.1 导入Pom

  1. <dependency>
  2.         <groupId>org.springframework.boot</groupId>
  3.         <artifactId>spring-boot-starter-web</artifactId>
  4. </dependency>
  6. <dependency>
  7.         <groupId>mysql</groupId>
  8.         <artifactId>mysql-connector-java</artifactId>
  9. </dependency>
  11. <dependency>
  12.         <groupId>org.mybatis.spring.boot</groupId>
  13.         <artifactId>mybatis-spring-boot-starter</artifactId>
  14.         <version>1.3.2</version>
  15. </dependency>
  17. <dependency>
  18.         <groupId>org.apache.shiro</groupId>
  19.         <artifactId>shiro-spring</artifactId>
  20.         <version>1.4.0</version>
  21. </dependency>

4.2 application.yml

  1. server:
  2.   port: 8903
  3. spring:
  4.   application:
  5.     name: lab-user
  6.   datasource:
  7.     driver-class-name: com.mysql.jdbc.Driver
  8.     url: jdbc:mysql://127.0.0.1:3306/laboratory?charset=utf8
  9.     username: root
  10.     password: root
  11. mybatis:
  12.   type-aliases-package: cn.ntshare.laboratory.entity
  13.   mapper-locations: classpath:mapper/*.xml
  14.   configuration:
  15.     map-underscore-to-camel-case: true

4.3 实体类

4.3.1 User.java
  1. @Data
  2. @ToString
  3. public class User implements Serializable {
  5.     private static final long serialVersionUID = -6056125703075132981L;
  7.     private Integer id;
  9.     private String account;
  11.     private String password;
  13.     private String username;
  14. }
4.3.2 Role.java
  1. @Data
  2. @ToString
  3. public class Role implements Serializable {
  5.     private static final long serialVersionUID = -1767327914553823741L;
  7.     private Integer id;
  9.     private String role;
  11.     private String desc;
  12. }

4.4 Dao层

4.4.1 PermissionMapper.java
  1. @Mapper
  2. @Repository
  3. public interface PermissionMapper {
  5.     List<String> findByRoleId(@Param("roleIds") List<Integer> roleIds);
  6. }
4.4.2 PermissionMapper.xml
  1. <mapper namespace="cn.ntshare.laboratory.dao.PermissionMapper">
  2.     <sql id="base_column_list">
  3.         id, permission, desc
  4.     </sql>
  6.     <select id="findByRoleId" parameterType="List" resultType="String">
  7.         select permission
  8.         from permission, role_permission rp
  9.         where rp.permission_id = permission.id and rp.role_id in
  10.         <foreach collection="roleIds" item="id" open="(" close=")" separator=",">
  11.             #{id}
  12.         </foreach>
  13.     </select>
  14. </mapper>
4.4.3 RoleMapper.java
  1. @Mapper
  2. @Repository
  3. public interface RoleMapper {
  5.     List<Role> findRoleByUserId(@Param("userId") Integer userId);
  6. }
4.4.4 RoleMapper.xml
  1. <mapper namespace="cn.ntshare.laboratory.dao.RoleMapper">
  2.     <sql id="base_column_list">
  3.         id, user_id, role_id
  4.     </sql>
  6.     <select id="findRoleByUserId" parameterType="Integer" resultType="Role">
  7.         select role.id, role
  8.         from role, user, user_role ur
  9.         where role.id = ur.role_id and ur.user_id = user.id and user.id = #{userId}
  10.     </select>
  11. </mapper>
4.4.5 UserMapper.java
  1. @Mapper
  2. @Repository
  3. public interface UserMapper {
  4.     User findByAccount(@Param("account") String account);
  5. }
4.4.6 UserMapper.xml
  1. <mapper namespace="cn.ntshare.laboratory.dao.UserMapper">
  3.     <sql id="base_column_list">
  4.         id, account, password, username
  5.     </sql>
  7.     <select id="findByAccount" parameterType="Map" resultType="User">
  8.         select
  9.         <include refid="base_column_list"/>
  10.         from user
  11.         where account = #{account}
  12.     </select>
  13. </mapper>

4.5 Service层

4.5.1 PermissionServiceImpl.java
  1. @Service
  2. public class PermissionServiceImpl implements PermissionService {
  4.     @Autowired
  5.     private PermissionMapper permissionMapper;
  7.     @Override
  8.     public List<String> findByRoleId(List<Integer> roleIds) {
  9.         return permissionMapper.findByRoleId(roleIds);
  10.     }
  11. }
4.5.2 RoleServiceImpl.java
  1. @Service
  2. public class RoleServiceImpl implements RoleService {
  4.     @Autowired
  5.     private RoleMapper roleMapper;
  7.     @Override
  8.     public List<Role> findRoleByUserId(Integer id) {
  9.         return roleMapper.findRoleByUserId(id);
  10.     }
  11. }
4.5.3 UserServiceImpl.java
  1. @Service
  2. public class UserServiceImpl implements UserService {
  4.     @Autowired
  5.     private UserMapper userMapper;
  7.     @Override
  8.     public User findByAccount(String account) {
  9.         return userMapper.findByAccount(account);
  10.     }
  11. }

4.6. 系统返回状态枚举与包装函数

4.6.1 ServerResponseEnum.java
  1. @AllArgsConstructor
  2. @Getter
  3. public enum ServerResponseEnum {
  4.     SUCCESS(0, "成功"),
  5.     ERROR(10, "失败"),
  7.     ACCOUNT_NOT_EXIST(11, "账号不存在"),
  8.     DUPLICATE_ACCOUNT(12, "账号重复"),
  9.     ACCOUNT_IS_DISABLED(13, "账号被禁用"),
  10.     INCORRECT_CREDENTIALS(14, "账号或密码错误"),
  11.     NOT_LOGIN_IN(15, "账号未登录"),
  12.     UNAUTHORIZED(16, "没有权限")
  13.     ;
  14.     Integer code;
  15.     String message;
  16. }
4.6.2 ServerResponseVO.java
  1. @Getter
  2. @Setter
  3. @NoArgsConstructor
  4. public class ServerResponseVO<T> implements Serializable {
  5.     private static final long serialVersionUID = -1005863670741860901L;
  6.     // 响应码
  7.     private Integer code;
  9.     // 描述信息
  10.     private String message;
  12.     // 响应内容
  13.     private T data;
  15.     private ServerResponseVO(ServerResponseEnum responseCode) {
  16.         this.code = responseCode.getCode();
  17.         this.message = responseCode.getMessage();
  18.     }
  20.     private ServerResponseVO(ServerResponseEnum responseCode, T data) {
  21.         this.code = responseCode.getCode();
  22.         this.message = responseCode.getMessage();
  23.         this.data = data;
  24.     }
  26.     private ServerResponseVO(Integer code, String message) {
  27.         this.code = code;
  28.         this.message = message;
  29.     }
  31.     /**
  32.      * 返回成功信息
  33.      * @param data      信息内容
  34.      * @param <T>
  35.      * @return
  36.      */
  37.     public static<T> ServerResponseVO success(T data) {
  38.         return new ServerResponseVO<>(ServerResponseEnum.SUCCESS, data);
  39.     }
  41.     /**
  42.      * 返回成功信息
  43.      * @return
  44.      */
  45.     public static ServerResponseVO success() {
  46.         return new ServerResponseVO(ServerResponseEnum.SUCCESS);
  47.     }
  49.     /**
  50.      * 返回错误信息
  51.      * @param responseCode      响应码
  52.      * @return
  53.      */
  54.     public static ServerResponseVO error(ServerResponseEnum responseCode) {
  55.         return new ServerResponseVO(responseCode);
  56.     }
  57. }

4.7 统一异常处理

当用户身份认证失败时，会抛出UnauthorizedException，我们可以通过统一异常处理来处理该异常

  1. @RestControllerAdvice
  2. public class UserExceptionHandler {
  4.     @ExceptionHandler(UnauthorizedException.class)
  5.     @ResponseStatus(HttpStatus.UNAUTHORIZED)
  6.     public ServerResponseVO UnAuthorizedExceptionHandler(UnauthorizedException e) {
  7.         return ServerResponseVO.error(ServerResponseEnum.UNAUTHORIZED);
  8.     }
  9. }

5. 集成Shiro

5.1 UserRealm.java

  1. /**
  2.  * 负责认证用户身份和对用户进行授权
  3.  */
  4. public class UserRealm extends AuthorizingRealm {
  6.     @Autowired
  7.     private UserService userService;
  9.     @Autowired
  10.     private RoleService roleService;
  12.     @Autowired
  13.     private PermissionService permissionService;
  15.     // 用户授权
  16.     protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principalCollection) {
  17.         User user = (User) principalCollection.getPrimaryPrincipal();
  18.         SimpleAuthorizationInfo authorizationInfo = new SimpleAuthorizationInfo();
  19.         List<Role> roleList = roleService.findRoleByUserId(user.getId());
  20.         Set<String> roleSet = new HashSet<>();
  21.         List<Integer> roleIds = new ArrayList<>();
  22.         for (Role role : roleList) {
  23.             roleSet.add(role.getRole());
  24.             roleIds.add(role.getId());
  25.         }
  26.         // 放入角色信息
  27.         authorizationInfo.setRoles(roleSet);
  28.         // 放入权限信息
  29.         List<String> permissionList = permissionService.findByRoleId(roleIds);
  30.         authorizationInfo.setStringPermissions(new HashSet<>(permissionList));
  32.         return authorizationInfo;
  33.     }
  35.     // 用户认证
  36.     protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authToken) throws AuthenticationException {
  37.         UsernamePasswordToken token = (UsernamePasswordToken) authToken;
  38.         User user = userService.findByAccount(token.getUsername());
  39.         if (user == null) {
  40.             return null;
  41.         }
  42.         return new SimpleAuthenticationInfo(user, user.getPassword(), getName());
  43.     }
  44. }

5.2 ShiroConfig.java

  1. @Configuration
  2. public class ShiroConfig {
  4.     @Bean
  5.     public UserRealm userRealm() {
  6.         return new UserRealm();
  7.     }
  9.     @Bean
  10.     public DefaultWebSecurityManager securityManager() {
  11.         DefaultWebSecurityManager securityManager = new DefaultWebSecurityManager();
  12.         securityManager.setRealm(userRealm());
  13.         return securityManager;
  14.     }
  16.     /**
  17.      * 路径过滤规则
  18.      * @return
  19.      */
  20.     @Bean
  21.     public ShiroFilterFactoryBean shiroFilter(DefaultWebSecurityManager securityManager) {
  22.         ShiroFilterFactoryBean shiroFilterFactoryBean = new ShiroFilterFactoryBean();
  23.         shiroFilterFactoryBean.setSecurityManager(securityManager);
  25.         shiroFilterFactoryBean.setLoginUrl("/login");
  26.         shiroFilterFactoryBean.setSuccessUrl("/");
  27.         Map<String, String> map = new LinkedHashMap<>();
  28.         // 有先后顺序
  29.         map.put("/login", "anon");      // 允许匿名访问
  30.         map.put("/**", "authc");        // 进行身份认证后才能访问
  31.         shiroFilterFactoryBean.setFilterChainDefinitionMap(map);
  32.         return shiroFilterFactoryBean;
  33.     }
  35.     /**
  36.      * 开启Shiro注解模式，可以在Controller中的方法上添加注解
  37.      * @param securityManager
  38.      * @return
  39.      */
  40.     @Bean
  41.     public AuthorizationAttributeSourceAdvisor authorizationAttributeSourceAdvisor(@Qualifier("securityManager") DefaultSecurityManager securityManager) {
  42.         AuthorizationAttributeSourceAdvisor authorizationAttributeSourceAdvisor = new AuthorizationAttributeSourceAdvisor();
  43.         authorizationAttributeSourceAdvisor.setSecurityManager(securityManager);
  44.         return authorizationAttributeSourceAdvisor;
  45.     }

5.3 LoginController.java

  1. @RestController
  2. @RequestMapping("")
  3. public class LoginController {
  5.     @PostMapping("/login")
  6.     public ServerResponseVO login(@RequestParam(value = "account") String account,
  7.                                   @RequestParam(value = "password") String password) {
  8.         Subject userSubject = SecurityUtils.getSubject();
  9.         UsernamePasswordToken token = new UsernamePasswordToken(account, password);
  10.         try {
  11.             // 登录验证
  12.             userSubject.login(token);
  13.             return ServerResponseVO.success();
  14.         } catch (UnknownAccountException e) {
  15.             return ServerResponseVO.error(ServerResponseEnum.ACCOUNT_NOT_EXIST);
  16.         } catch (DisabledAccountException e) {
  17.             return ServerResponseVO.error(ServerResponseEnum.ACCOUNT_IS_DISABLED);
  18.         } catch (IncorrectCredentialsException e) {
  19.             return ServerResponseVO.error(ServerResponseEnum.INCORRECT_CREDENTIALS);
  20.         } catch (Throwable e) {
  21.             e.printStackTrace();
  22.             return ServerResponseVO.error(ServerResponseEnum.ERROR);
  23.         }
  24.     }
  26.     @GetMapping("/login")
  27.     public ServerResponseVO login() {
  28.         return ServerResponseVO.error(ServerResponseEnum.NOT_LOGIN_IN);
  29.     }
  31.     @GetMapping("/auth")
  32.     public String auth() {
  33.         return "已成功登录";
  34.     }
  36.     @GetMapping("/role")
  37.     @RequiresRoles("vip")
  38.     public String role() {
  39.         return "测试Vip角色";
  40.     }
  42.     @GetMapping("/permission")
  43.     @RequiresPermissions(value = {"add", "update"}, logical = Logical.AND)
  44.     public String permission() {
  45.         return "测试Add和Update权限";
  46.     }
  47. }

6. 测试

6.1 用root用户登录

6.1.1 登录

6.1.2 验证是否登录

6.1.3 测试角色权限

6.1.4 测试用户操作权限

6.2 user用户和vip用户测试略

7. 总结

本文演示了SpringBoot极简集成Shiro框架，实现了基础的身份认证和授权功能，如有不足，请多指教。

后续可扩展的功能点有：

集成Redis实现Shiro的分布式会话
*
集成JWT实现单点登录功能

版权说明 : 本文为转载文章, 版权归原作者所有 版权申明

原文链接 : https://blog.csdn.net/MarkerHub/article/details/120540673

内容来源于网络，如有侵权，请联系作者删除！

JavashiroJWT网络Access

相关文章

    查看更多

    热门标签

    更多
    JavaquerypythonNode开发语言requestUtil数据库Table后端算法LoggerMessageElementParser

    最新文章

    更多

    目录

    • 蜀ICP备13028337号-1 大数据知识库 https://www.saoniuhuo.com © All rights reserved
    • 本站内容来源互联网,如果侵犯您的权益请联系我们删除, 联系方式：448109455@qq.com