SpringBoot-shiro

1. SpringBoot-shiro

12.1 快速入门

1、导入依赖

        org.apache.shiro
        shiro-core
        1.8.0

        org.slf4j
        jcl-over-slf4j
        1.8.0-beta0

        org.slf4j
        slf4j-log4j12
        1.8.0-beta0

        log4j
        log4j
        1.2.17

2、创建log4j.properties文件

log4j.rootLogger=INFO, stdout

log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d %p [%c] - %m %n

General Apache libraries
log4j.logger.org.apache=WARN

Spring
log4j.logger.org.springframework=WARN

Default Shiro logging
log4j.logger.org.apache.shiro=INFO

Disable verbose logging
log4j.logger.org.apache.shiro.util.ThreadContext=WARN
log4j.logger.org.apache.shiro.cache.ehcache.EhCache=WARN

3、创建shiro.ini文件

[users]
user 'root' with password 'secret' and the 'admin' role
root = secret, admin
user 'guest' with the password 'guest' and the 'guest' role
guest = guest, guest
user 'presidentskroob' with password '12345' ("That's the same combination on
my luggage!!!" ;)), and role 'president'
presidentskroob = 12345, president
user 'darkhelmet' with password 'ludicrousspeed' and roles 'darklord' and 'schwartz'
darkhelmet = ludicrousspeed, darklord, schwartz
user 'lonestarr' with password 'vespa' and roles 'goodguy' and 'schwartz'
lonestarr = vespa, goodguy, schwartz

-----------------------------------------------------------------------------
Roles with assigned permissions
#
Each line conforms to the format defined in the
org.apache.shiro.realm.text.TextConfigurationRealm#setRoleDefinitions JavaDoc
-----------------------------------------------------------------------------
[roles]
'admin' role has all permissions, indicated by the wildcard '*'
admin = *
The 'schwartz' role can do anything (*) with any lightsaber:
schwartz = lightsaber:*
The 'goodguy' role is allowed to 'drive' (action) the winnebago (type) with
license plate 'eagle5' (instance specific id)
goodguy = winnebago:drive:eagle5

4、创建Quickstart.java类

import org.apache.shiro.SecurityUtils;
import org.apache.shiro.authc.*;
import org.apache.shiro.mgt.DefaultSecurityManager;
import org.apache.shiro.realm.text.IniRealm;
import org.apache.shiro.session.Session;
import org.apache.shiro.subject.Subject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Simple Quickstart application showing how to use Shiro's API.

 *
 * @since 0.9 RC2
 */
public class Quickstart {

    private static final transient Logger log = LoggerFactory.getLogger(Quickstart.class);

    public static void main(String[] args) {

        // 已过时
//        Factory factory = new IniSecurityManagerFactory("classpath:shiro.ini");
//        SecurityManager securityManager = factory.getInstance();

        DefaultSecurityManager securityManager = new DefaultSecurityManager();
        IniRealm iniRealm = new IniRealm("classpath:shiro.ini");
        securityManager.setRealm(iniRealm);

        SecurityUtils.setSecurityManager(securityManager);

        // Now that a simple Shiro environment is set up, let's see what you can do:
        // get the currently executing user:
        // 获取当前的用户对象 Subject
        Subject currentUser = SecurityUtils.getSubject();

        // Do some stuff with a Session (no need for a web or EJB container!!!)
        // 通过当前用户获得Session
        Session session = currentUser.getSession();
        session.setAttribute("someKey", "aValue");
        String value = (String) session.getAttribute("someKey");
        if (value.equals("aValue")) {
            log.info("Subject=》session! [" + value + "]");
        }

        // let's login the current user so we can check against roles and permissions:
        // 判断当前的用户是否被认证
        if (!currentUser.isAuthenticated()) {

            // token : 令牌
            UsernamePasswordToken token = new UsernamePasswordToken("lonestarr", "vespa");
            token.setRememberMe(true); // 设置记住我
            try {
                currentUser.login(token);// 执行了登录操作
            } catch (UnknownAccountException uae) {//用户名不存在
                log.info("There is no user with username of " + token.getPrincipal());
            } catch (IncorrectCredentialsException ice) {// 密码错误
                log.info("Password for account " + token.getPrincipal() + " was incorrect!");
            } catch (LockedAccountException lae) { // 用户被锁定了
                log.info("The account for username " + token.getPrincipal() + " is locked.  " +
                        "Please contact your administrator to unlock it.");
            }
            // ... catch more exceptions here (maybe custom ones specific to your application?

            catch (AuthenticationException ae) { //大异常，认证异常
                //unexpected condition?  error?

            }
        }

        //say who they are:
        //print their identifying principal (in this case, a username):
        log.info("User [" + currentUser.getPrincipal() + "] logged in successfully.");

        //test a role:
        if (currentUser.hasRole("schwartz")) {
            log.info("May the Schwartz be with you!");
        } else {
            log.info("Hello, mere mortal.");
        }

        //粗粒度
        //test a typed permission (not instance-level)
        if (currentUser.isPermitted("lightsaber:wield")) {
            log.info("You may use a lightsaber ring.  Use it wisely.");
        } else {
            log.info("Sorry, lightsaber rings are for schwartz masters only.");
        }

        //细粒度
        //a (very powerful) Instance Level permission:
        if (currentUser.isPermitted("winnebago:drive:eagle5")) {
            log.info("You are permitted to 'drive' the winnebago with license plate (id) 'eagle5'.  " +
                    "Here are the keys - have fun!");
        } else {
            log.info("Sorry, you aren't allowed to drive the 'eagle5' winnebago!");
        }

        //all done - log out!

        //注销
        currentUser.logout();

        //结束
        System.exit(0);
    }
}

5、启动测试

12.2 shiro-Mybatis

1、导入依赖

        com.github.theborakompanioni
        thymeleaf-extras-shiro
        2.1.0

        org.projectlombok
        lombok
        1.18.22
        provided

        org.mybatis.spring.boot
        mybatis-spring-boot-starter
        2.2.0

        mysql
        mysql-connector-java
        8.0.27

        log4j
        log4j
        1.2.17

        com.alibaba
        druid
        1.2.8

        org.apache.shiro
        shiro-spring-boot-web-starter
        1.8.0

        org.springframework.boot
        spring-boot-starter-thymeleaf
        2.5.6

        org.springframework.boot
        spring-boot-starter-web

        org.springframework.boot
        spring-boot-starter-test
        test

2、配置数据库

application.yaml

spring:
  datasource:
    username: root
    password: aadzj
    #    如果报错是时区问题 加上 serverTimezone=UTC 就OK
    url: jdbc:mysql://localhost:3306/userdb?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8
    driver-class-name: com.mysql.cj.jdbc.Driver
    type: com.alibaba.druid.pool.DruidDataSource

    #druid数据源专有配置
    initialSize: 5
    minIdle: 5
    maxActive: 20
    maxWait: 60000
    timeBetweenEvictionRunsMillis: 60000
    minEvictableIdleTimeMillis: 300000
    validationQuery: SELECT 1 FROM DUAL
    testWhileIdle: true
    testOnBorrow: false
    testOnReturn: false
    poolPreparedStatements: true

    #配置监控统计拦截的filters，stat：监控统计、log4j：日志记录、wall：防御sql注入
    #如果允许报错，java.lang.ClassNotFoundException: org.apache.Log4j.Properity
    #则导入log4j 依赖就行
    filters: stat,wall,log4j
    maxPoolPreparedStatementPerConnectionSize: 20
    useGlobalDataSourceStat: true
    connectionoProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=500

3、编写实体类

文件路径：com–dzj–pojo–User.java

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    private String id;
    private String username;
    private String password;
    private String perms;
}

4、编写Mapper接口

文件路径：com–dzj–mapper–UserMapper.java

@Repository
@Mapper
public interface UserMapper {
    public User queryByUsername(String username);
}

5、配置全限定类别名，关联配置文件

同样在application.yaml中配置即可

mybatis整合 全限定类别名，关联配置文件
mybatis:
  type-aliases-package: com.dzj.pojo
  mapper-locations: classpath:mapper/*.xml

6、编写Mapper映射文件

文件路径：resources–mapper–UserMapper.xml

        select * from userdb.user where username = #{username}

7、编写业务层

接口UserService.java

文件路径：com–dzj–service–UserService.java

package com.dzj.service;

import com.dzj.pojo.User;

public interface UserService {
    public User queryByUsername(String username);
}

接口UserService.java实现类

文件路径：com–dzj–service–UserServiceImpl.java

@Service
public class UserServiceImpl implements UserService {

    @Autowired
    UserMapper userMapper;
    @Override
    public User queryByUsername(String username) {
        return userMapper.queryByUsername(username);
    }
}

8、编写controller层

文件路径：com–dzj-controller–MyController.java

package com.dzj.controller;

import org.apache.shiro.SecurityUtils;
import org.apache.shiro.authc.AuthenticationException;
import org.apache.shiro.authc.IncorrectCredentialsException;
import org.apache.shiro.authc.UnknownAccountException;
import org.apache.shiro.authc.UsernamePasswordToken;
import org.apache.shiro.subject.Subject;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class MyController {

    @RequestMapping({"/","/index","/index.html"})
    public String toIndex(Model model){
        model.addAttribute("msg","helle,Shiro");
        return "index";
    }

    @RequestMapping("/user/add")
    public String add(){
        return "user/add";
    }

    @RequestMapping("/user/update")
    public String update(){
        return "user/update";
    }

    @RequestMapping("/toLogin")
    public String toLogin(){
        return "login";
    }

    @RequestMapping("/login")
    public String login(String username,String password,Model model){
        // 获取当前用户
        Subject subject = SecurityUtils.getSubject();
        // 封装用户的登录数据
        UsernamePasswordToken token = new UsernamePasswordToken(username, password);
        try {
            subject.login(token); //执行登录方法，如果没有异常就说明OK了
            return "index";
        } catch (UnknownAccountException e) {// 用户名不存在
            model.addAttribute("msg","用户名错误");
            return "login";
        }catch (IncorrectCredentialsException e) {// 密码不存在
            model.addAttribute("msg","密码错误");
            return "login";
        }
    }

    @RequestMapping("/noauth")
    @ResponseBody
    public String uauthorized(){
        return "未经授权无法访问此页面！";
    }
}

9、编写shiro配置类

文件路径：com–dzj–config–ShiroConfig.java

package com.dzj.config;

import at.pollux.thymeleaf.shiro.dialect.ShiroDialect;
import org.apache.shiro.spring.web.ShiroFilterFactoryBean;
import org.apache.shiro.web.mgt.DefaultWebSecurityManager;
import org.apache.shiro.web.session.mgt.DefaultWebSessionManager;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.util.LinkedHashMap;
import java.util.Map;

@Configuration
public class ShiroConfig {

    // ShiroFilterFactoryBean，步骤3
    @Bean(name = "shiroFilterFactoryBean")
    public ShiroFilterFactoryBean getShiroFilterFactoryBean(@Qualifier("defaultWebSecurityManager")DefaultWebSecurityManager securityManager){
        ShiroFilterFactoryBean bean = new ShiroFilterFactoryBean();
        // 设置安全管理器
        bean.setSecurityManager(securityManager);
        //添加shiro内置的过滤器
        /*
            anon: 无需认证就可以登录
            authc: 必须认证了才能访问
            user：必须拥有 记住我 功能才能用
            perms：拥有对某个资源的权限才能访问
            role：拥有某个角色权限才能访问
         */
        Map filterMap = new LinkedHashMap<>();
//        filterMap.put("/user/add","authc");
//        filterMap.put("/user/update","authc");
        // 同样也支持通配符 *
        filterMap.put("/user/add","perms[user:add]");
        filterMap.put("/user/update","perms[user:update]");//perms只有授权了才能访问对象的页面
        filterMap.put("/user/*","authc");  //authc主要通过了登录认证，就能进入根目录user
        //授权
        bean.setFilterChainDefinitionMap(filterMap);
        //设置登录请求认证
        bean.setLoginUrl("/toLogin");
        //未授权页面
        bean.setUnauthorizedUrl("/noauth");
        return bean;
    }
    // DefaultWebSecurityManager，步骤2
    @Bean(name="defaultWebSecurityManager")
    public DefaultWebSecurityManager getDefaultWebSecurityManager(@Qualifier("userRealm") UserRealm userRealm){
        DefaultWebSecurityManager securityManager = new DefaultWebSecurityManager();
        securityManager.setSessionManager(sessionManager());
        // 关联UserRealm
        securityManager.setRealm(userRealm);
        return securityManager;
    }
    /*
        在Shiro进行第一次重定向时，会在url后携带jsessionid，这会导致400错误（无法找到该网页）。解决办法：在Shiro的配置类中的sessionManager()方法中，将sessionIdUrlRewritingEnabled属性设置为false。该方法返回一个DefaultWebSessionManager实例。
     */
    @Bean
    public DefaultWebSessionManager sessionManager() {
        DefaultWebSessionManager sessionManager = new DefaultWebSessionManager();
        sessionManager.setSessionIdUrlRewritingEnabled(false);
        return sessionManager;
    }
    // 创建 Realm 对象，需要自定义类,步骤1
    @Bean
    public UserRealm userRealm(){
        return new UserRealm();
    }
    //整合shiroDialect：用来整合shiro 和 thymeleaf
    @Bean
    public ShiroDialect getShiroDialect(){
        return new ShiroDialect();
    }
}

编写UserRealm类

文件路径：com–dzj–config–UserRealm.java

package com.dzj.config;

import com.dzj.pojo.User;
import com.dzj.service.UserService;
import org.apache.shiro.SecurityUtils;
import org.apache.shiro.authc.*;
import org.apache.shiro.authz.AuthorizationInfo;
import org.apache.shiro.authz.SimpleAuthorizationInfo;
import org.apache.shiro.realm.AuthorizingRealm;
import org.apache.shiro.subject.PrincipalCollection;
import org.apache.shiro.subject.Subject;
import org.springframework.beans.factory.annotation.Autowired;

// 自定义的 UserRealm,继承自AuthorizingRealm
public class UserRealm extends AuthorizingRealm {
    @Autowired
    UserService userService;
    // 授权
    @Override
    protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principalCollection) {
        System.out.println("执行了=>授权doGetAuthorizationInfo");
        //SimpleAuthorizationInfo
        SimpleAuthorizationInfo info = new SimpleAuthorizationInfo();
//        info.addStringPermission("user:add");
        Subject subject = SecurityUtils.getSubject();
        User currentUser = (User) subject.getPrincipal();//拿到user对象
        //设置当前用户的权限，从数据库中获取
        info.addStringPermission(currentUser.getPerms());
        return info;
    }

    // 认证
    @Override
    protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {
        System.out.println("执行了=>认证doGetAuthenticationInfo");
        UsernamePasswordToken userToken = (UsernamePasswordToken) token;
        // 用户名，密码  可以数据库中取
//        String username = "root";
//        String password = "aadzj";

        //用户名认证
//        if(!userToken.getUsername().equals(username)){
//            return null; //自动抛出异常，UnknownAccountException
//        }
        //连接真实的数据库
        User user = userService.queryByUsername(userToken.getUsername());
        if(user==null){
            return null;//返回null则自动抛出异常，UnknownAccountException
        }
        //可以加密：MD5 MD5盐值加密
        //密码认证不需要我们做，shiro做~，加密了
        return new SimpleAuthenticationInfo(user,user.getPassword(),"");
    }
}

10、前端页面

index.html

文件路径：resources–templates–index.html

    Title

    首页

    登录

        add

        update

login.html

文件路径：resources–templates–login.html

    Title

登录

    用户名：
    密码：

add.html

文件路径：resources–templates–user–add.html

    add

update.html

文件路径：resources–templates–user–update.html

    update

搞定，结束~

Original: https://www.cnblogs.com/aadzj/p/15636817.html
Author: 小公羊
Title: SpringBoot-shiro