對狂神的shiro的學習總結

1.shiro的10分鍾快速開始

• 導入依賴
  新建一個普通的maven項目,然后new一個hello-shiro(moudle)作為第一個測試項目
  具體框架如下:
  

導入對應的依賴在pom.xml文件里

<dependencies>
        <!-- https://mvnrepository.com/artifact/org.apache.shiro/shiro-core -->
        <dependency>
            <groupId>org.apache.shiro</groupId>
            <artifactId>shiro-core</artifactId>
            <version>1.7.1</version>
        </dependency>

        <!-- configure logging -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>jcl-over-slf4j</artifactId>
            <version>1.7.21</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
            <version>1.7.21</version>
        </dependency>
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>
    </dependencies>

• 配置文件
  在官方的github目錄下下載zip或者直接copy代碼

shiro的github請點擊這

在resources目錄下新建一個log4j.properties和shiro.ini文件
如果idea創建失敗ini文件或者識別ini失敗可以看IDEA中怎么創建ini文件
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

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

在java目錄導入Quickstart.java,具體代碼如下:

import org.apache.shiro.SecurityUtils;
import org.apache.shiro.authc.*;
import org.apache.shiro.config.IniSecurityManagerFactory;
import org.apache.shiro.mgt.SecurityManager;
import org.apache.shiro.session.Session;
import org.apache.shiro.subject.Subject;
import org.apache.shiro.util.Factory;
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<SecurityManager> factory = new IniSecurityManagerFactory("classpath:shiro.ini");
        SecurityManager securityManager = factory.getInstance();
        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 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("Retrieved the correct value! [" + value + "]");
        }

        //判斷當前用戶是否被認證
        //Token:沒有獲取,直接設置令牌
        if (!currentUser.isAuthenticated()) {
            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);
    }
}

• HelloWorld

開啟項目檢查

看到能打印出這行信息,說明快如入門成功

2.springboot整合shiro環境搭建

新建一個moudle叫shiro-springboot

勾選spring web依賴即可

在pom.xml中導入thymeleaf依賴

<!--        thymeleaf模板-->
        <dependency>
            <groupId>org.thymeleaf</groupId>
            <artifactId>thymeleaf-spring5</artifactId>
        </dependency>
        <dependency>
            <groupId>org.thymeleaf.extras</groupId>
            <artifactId>thymeleaf-extras-java8time</artifactId>
        </dependency>

新建一個controller編寫一個MyController測試,代碼如下:

package cn.dzp.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class MyController {
    @RequestMapping({"/index","/"})
    public String toIndex(Model model){
        model.addAttribute("msg","hello,shiro");
        return "index";
    }
}

在templates下新建一個index.html,導入thymeleaf約束,這樣可以編寫thymeleaf提示

xmlns:th="http://www.themeleaf.org"

index.html完整代碼如下:

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.themeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>首頁</title>
</head>
<body>
<h1>首頁</h1>
<p  th:text="${msg}"></p>
</body>
</html>

運行項目檢查

可以看到可以跑通!

shiro的三大對象:

• Subject:用戶
• SecurityManager:管理所有用戶
• Realm:連接數據

pom.xml導入依賴:

<!--shiro整合包-->
        <dependency>
            <groupId>org.apache.shiro</groupId>
            <artifactId>shiro-spring</artifactId>
            <version>1.7.1</version>
        </dependency>

創建一個config包編寫ShiroConfig配置類
代碼如下:

package cn.dzp.config;

import org.apache.shiro.spring.web.ShiroFilterFactoryBean;
import org.apache.shiro.web.mgt.DefaultWebSecurityManager;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class ShiroConfig {
//    ShiroFilterFactoryBean:第三步
    @Bean
    public ShiroFilterFactoryBean getShiroFilterFactoryBean(@Qualifier("securityManager") DefaultWebSecurityManager defaultWebSecurityManager){
        ShiroFilterFactoryBean bean = new ShiroFilterFactoryBean();
//        設置安全管理器
        bean.setSecurityManager(defaultWebSecurityManager);
        return bean;
    }
//    DefaultWebSecurityManager:第二步
    @Bean(name = "securityManager")
    public DefaultWebSecurityManager getDefaultWebSecurityManager(@Qualifier("userRealm") UserRealm userRealm){
        DefaultWebSecurityManager securityManager = new DefaultWebSecurityManager();
//        關聯UserRealm
        securityManager.setRealm(userRealm);
        return securityManager;
    }
//    Realm:創建realm對象,需要自定義:第一步,從后往前配置
    @Bean
    public UserRealm userRealm(){
        return new UserRealm();
    }
}

因為配置涉及到userRealm,這個需要自己自定義,所以在config包下再寫一個UserRealm類
代碼如下:

package cn.dzp.config;

import org.apache.shiro.authc.AuthenticationException;
import org.apache.shiro.authc.AuthenticationInfo;
import org.apache.shiro.authc.AuthenticationToken;
import org.apache.shiro.authz.AuthorizationInfo;
import org.apache.shiro.realm.AuthorizingRealm;
import org.apache.shiro.subject.PrincipalCollection;

//自定義的UserRealm
public class UserRealm extends AuthorizingRealm {
//    授權
    @Override
    protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principalCollection) {
        System.out.println("執行了授權的=>doGetAuthorizationInfo");
        return null;
    }
//認證
    @Override
    protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authenticationToken) throws AuthenticationException {
        System.out.println("執行了認證的=>doGetAuthenticationInfo");
        return null;
    }
}

在templates建一個user夾放關於用戶的頁面:add.html;update:html

回到MyController
添加兩個頁面跳轉的方法

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

回到主頁index.html

再次重啟項目檢查

可以實現跳轉add和update頁面

到此環境搭建完成!

3.shiro實現登陸攔截

在ShiroConfig添加shiro的內置過濾器

//        添加shiro的內置過濾器
        /*
        * anon:無需認證都可訪問
        * authc: 必須認證了才能訪問
        * user:必須擁有 記住我 才能用
        * perms:擁有對某個資源的權限才能訪問
        * role:擁有某個角色權限才能訪問*/
        LinkedHashMap<String, String> filterMap = new LinkedHashMap<>();
        filterMap.put("/user/add","authc");
        filterMap.put("/user/update","authc");
        //filterMap.put("/user/*","authc");攔截所有user下的請求
        bean.setFilterChainDefinitionMap(filterMap);

再次運行項目點擊add,發現失敗,此時攔截已經成功了

因為它跳轉的url是login頁面,所以還得重寫login頁面
代碼如下:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>用戶登錄</title>
</head>
<body>
<h1>登錄</h1>
<form action="/toLogin" method="post">
<p>用戶名: <input type="text" name="username"></p>
<p>密碼: <input type="password" name="password"></p>
<p><input type="submit"></p>
</form>
</body>
</html>

MyController添加方法

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

配置登錄頁面

點擊add或者update已經跳轉到了登錄頁面,說明已經攔截成功!

4.shiro實現用戶認證

在MyController添加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";
        }
    }

在login.html寫入信息msg

啟動項目隨便登錄測試一下

在UserRealm代碼下修改認證代碼:

//認證
@Override
protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {
System.out.println("執行了認證的=>doGetAuthenticationInfo");
// 用戶名,密碼到數據庫中取
String name="root";
String password="123456";
UsernamePasswordToken userToken = (UsernamePasswordToken) token;
if (!userToken.getUsername().equals(name)){
return null;//拋出異常:UnknownAccountException
}
// 密碼認證:shiro做
return new SimpleAuthenticationInfo("",password,"");
}

重啟項目查看,登錄寫的數據

可以看到登陸成功

5.shiro整合mybatis

在pom.xml導入對應的依賴

<!--        整合mybatis-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.2.6</version>
        </dependency>

        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.1.4</version>
        </dependency>

在resource目錄下新建application.yaml配置文件

spring:
  datasource:
    username: root
    password: 123456
    url: jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEncoding=utf-8
    driver-class-name: com.mysql.cj.jdbc.Driver
    #    使用德魯伊的數據源
    type: com.alibaba.druid.pool.DruidDataSource
    #Spring Boot 默認是不注入這些屬性值的,需要自己綁定
    #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:日志記錄(需要導入log4j依賴)
    # wall:防御sql注入
    filters: stat,wall,log4j
    maxPoolPreparedStatementPerConnectionSize: 20
    useGlobalDataSourceStat: true
    connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=500

新建數據庫連接綁定mybatis的數據庫

application.properties文件里配置mybatis的相關設置

由於配置文件里多了別名的掃描和mapper的文件,所以要完整架構,新建一個pojo實體類和mapper的包,如下

pojo實體類為了方便代碼簡潔,我使用了lombok,在pom導入對應依賴即可

<dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

實體類如下:

package cn.dzp.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private int id;
    private String name;
    private String pwd;
}

編寫mapper

在編寫UserMapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="cn.dzp.mapper.UserMapper">
    <select id="queryUserByName" parameterType="String" resultType="user">
        select * from user where name=#{name}
    </select>
</mapper>

在新建service寫一個UserService接口和它的實現類

UserMapperImpl實現類代碼:

package cn.dzp.mapper;

import cn.dzp.pojo.User;
import cn.dzp.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class UserMapperImpl implements UserService {
    @Autowired
    UserMapper userMapper;
    @Override
    public User queryUserByName(String name) {
        return userMapper.queryUserByName(name);
    }
}

在測試類測試代碼

可以看到查詢成功

這樣就可以去改Realm的代碼,開始的用戶名和密碼都是手寫偽造的

UserRealm代碼修改如下:

package cn.dzp.config;

import cn.dzp.pojo.User;
import cn.dzp.service.UserService;
import org.apache.shiro.authc.*;
import org.apache.shiro.authz.AuthorizationInfo;
import org.apache.shiro.realm.AuthorizingRealm;
import org.apache.shiro.subject.PrincipalCollection;
import org.springframework.beans.factory.annotation.Autowired;

//自定義的UserRealm
public class UserRealm extends AuthorizingRealm {
    @Autowired
    UserService userService;
//    授權
    @Override
    protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principalCollection) {
        System.out.println("執行了授權的=>doGetAuthorizationInfo");
        return null;
    }
//認證
    @Override
    protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {
        System.out.println("執行了認證的=>doGetAuthenticationInfo");
//        用戶名,密碼到數據庫中取
//        鏈接真實的數據庫
        UsernamePasswordToken userToken = (UsernamePasswordToken) token;
        User user = userService.queryUserByName(userToken.getUsername());
        if (user==null){//沒有這個人
            return null;//UnknownAccoutException
        }
//        密碼認證:shiro做
//         密碼可以加密:md5,md5鹽值加密
        return new SimpleAuthenticationInfo("",user.getPwd(),"");
    }
}

現在的話登錄用戶就是數據庫中的,啟動項目測試

可以看到登錄成功

6.shiro實現請求授權

在ShiroConfig添加部分代碼,如圖:

登錄用戶點擊添加的請求,顯示未授權401的錯誤

正常情況下,授權會跳轉到未授權的頁面,所以才MyController寫一個跳轉到未授權的頁面方法

@ResponseBody
    @RequestMapping("/noauth")
    public String unauthorized(){
        return "無法訪問此頁面";
    }

ShiroConfig類修改一下:

重啟項目測試,發現已經可以跳轉到我們設置的未授權的頁面了

怎樣添加add頁面的授權呢,在UserRealm修改下代碼,因為ShiroConfig設定了add頁面需要權限,所以要在UserRealm添加權限

但是所有登錄的用戶都有此權限,所以我打算把數據庫的表新增一個權限的字段,添加下權限

記得改下User實體類

UserRealm類

ShiroConfig里添加對update的過濾

開啟項目測試:
登錄有add權限的賬號dzp

點擊add,成功跳轉

登錄有update權限的賬號root

點擊update,成功跳轉

7.shiro整合thymeleaf

導入對應的依賴

<!--        shiro整合thymeleaf-->
        <dependency>
            <groupId>com.github.theborakompanioni</groupId>
            <artifactId>thymeleaf-extras-shiro</artifactId>
            <version>2.0.0</version>
        </dependency>

ShiroConfig類添加方法
//    整合ShiroDialect:用來整合shiro thymeleaf
    @Bean
    public ShiroDialect getShiroDialect(){
        return new ShiroDialect();
    }
        

在index.html添加約束

xmlns:shiro="http://www.thymeleaf.org/thymeleaf-extras-shiro"

運行項目測試

沒有權限不會顯示add和update的頁面

為了讓登錄后不在顯示登錄按鈕,需要在UserRealm里添加代碼

然后在前端判斷它從而決定顯不顯示登錄按鈕,
index.html:

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.themeleaf.org"
        xmlns:shiro="http://www.thymeleaf.org/thymeleaf-extras-shiro">
<head>
    <meta charset="UTF-8">
    <title>首頁</title>
</head>
<body>
<h1>首頁</h1>
<p  th:text="${msg}"></p>

<div shiro:hasPermission="user:add">
    <a th:href="@{/user/add}">添加</a>
</div>

<div shiro:hasPermission="user:update">
    <a th:href="@{/user/update}">更新</a>
</div>

<br>
<div th:if="${session.loginUser==null}"><a th:href="@{/toLogin}">登錄</a></div>
<div><a th:href="@{/logout}">注銷</a></div>

</body>
</html>

運行項目檢查,登錄后登錄按鈕消失

關於本人對狂神大佬的shiro的項目總結到此結束!