shiro 與 SpringMVC的整合完美示例

更新時(shí)間：2021年08月14日 14:08:34 作者：哦客源

shiro可以直接和spring整合，但是這樣需要單獨(dú)配置spring用于整合shiro，在配置springmvc，接下來(lái)通過(guò)實(shí)例代碼給大家介紹shiro 整合 SpringMVC 的方法，感興趣的朋友一起看看吧

想要整合Shiro和springmvc，在網(wǎng)上找了很多例子，感覺(jué)都有一點(diǎn)復(fù)雜。所以就自己寫了一個(gè)最簡(jiǎn)單整合項(xiàng)目，記錄在這里以備后面查看。

這個(gè)例子包含如下三個(gè)部分：

1.簡(jiǎn)單的頁(yè)面

2.shiro配置

3.springmvc配置

shiro可以直接和spring整合，但是這樣需要單獨(dú)配置spring用于整合shiro，在配置springmvc。配置文件看起來(lái)亂七八糟的。所以這里就shiro不采用spring來(lái)管理。因此這里的整合類似 shiro + servlet + springmvc。這樣配置相對(duì)簡(jiǎn)單好理解。但也是最簡(jiǎn)單的配置，只能用于學(xué)習(xí)，用在實(shí)際項(xiàng)目中，還得改寫。

下面是項(xiàng)目結(jié)構(gòu)圖（realm那個(gè)文件夾可有可沒(méi)有，只是如果刪除了，就需要將shiro.ini文件中 myrealm = shirospringweb.realm xxxx 那行刪除掉）

下面是具體步驟

(1).添加依賴

既然是簡(jiǎn)單，那引用也是最少的，具體如下

dependencies {
    // Use JUnit Jupiter for testing.
    testImplementation 'org.junit.jupiter:junit-jupiter:5.7.1'

    // This dependency is used by the application.
    implementation 'com.google.guava:guava:30.1-jre'
	
	// ++ Adding Spring dependencies
	implementation 'org.springframework:spring-context:5.3.9'
	implementation 'org.springframework:spring-webmvc:5.3.9'
	
	// ++ Using Servlet for SpringMvc
	implementation 'javax.servlet:javax.servlet-api:4.0.1'
	
	// ++ Using shiro-web
	implementation 'org.apache.shiro:shiro-web:1.7.1'
}

其中前面兩個(gè)是建立項(xiàng)目自帶的，所以只需要引用后面的四個(gè)包就可以咯

(2).Servlet中配置Shiro

在servlet整合shiro，只需要在web.xml中引用shiro的上下文監(jiān)聽(tīng)器（讀取shiro配置文件），并配置shiro過(guò)濾器即可，具體如下：

<!-- Shiro直接攔截，不經(jīng)過(guò)spring -->
<listener>
	<listener-class>org.apache.shiro.web.env.EnvironmentLoaderListener</listener-class>
</listener>
<!-- 對(duì)應(yīng)filter-->
<filter>
	<filter-name>shiroFilter</filter-name>
	<filter-class>org.apache.shiro.web.servlet.ShiroFilter</filter-class>
	</filter>
<!-- filter Mapping-->
<filter-mapping>
	<filter-name>shiroFilter</filter-name>
	<url-pattern>/*</url-pattern>
</filter-mapping>

在web.xml中配置好shiro后，需要在WEB-INF文件夾下書(shū)寫shiro.ini的配置文件，具體如下

[main]
authc.loginUrl = /login
authc.usernameParam = username
authc.passwordParam = password
authc.successUrl = /
authc.failureKeyAttribute = shiroLoginFailure
logout.redirectUrl = /
myrealm = shirospringweb.realm.MyRealm

[users]
liang = 123, role1
wang = 123, role2

[urls]
/ = anon
/test = anon
/test2 = authc
/login = authc
/logout = logout
/** = anon

這樣shiro就可以配合servlet工作了

(3).配置springMVC

最簡(jiǎn)單springmvc的配置，只需要配置一個(gè)DispatcherServlet，并在其配置文件(resources/springmvc-base.xml)中打開(kāi)包掃描，就好了，具體如下：

<!-- 配置SpringMVC -->
<servlet>
	<servlet-name>springServlet</servlet-name>
	<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
	<init-param>
		<param-name>contextConfigLocation</param-name>
		<param-value>classpath:springmvc-base.xml</param-value>
	</init-param>
</servlet>
<!-- 對(duì)應(yīng)servlet mapping -->
<servlet-mapping>
	<servlet-name>springServlet</servlet-name>
	<url-pattern>/*</url-pattern>
</servlet-mapping>

resources/springmvc-base.xml的配置文件如下（主要是打開(kāi)包掃描和注解驅(qū)動(dòng)）：

<?xml version="1.0" encoding="utf-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:context="http://www.springframework.org/schema/context"
    xmlns:mvc="http://www.springframework.org/schema/mvc"
	xmlns:aop="http://www.springframework.org/schema/aop"
    xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.1.xsd
        http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.1.xsd
		http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd">
		
		
		<context:component-scan base-package="shirospringweb.controller"/>
		
		<mvc:annotation-driven />
		
		<!-- 用來(lái)處理當(dāng) DispatcherServlet 攔截全部請(qǐng)求的時(shí)候，它在RequestHandler處撿出靜態(tài)資源的請(qǐng)求 -->
		<mvc:default-servlet-handler />
		
</beans>

然后書(shū)寫上面shiro配置文件中的對(duì)應(yīng)controller和前端頁(yè)面就可以了。具體如下：

3.1 TestController 及其頁(yè)面

TestController的代碼，如下所示

package shirospringweb.controller;

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

@Controller
public class TestController{
	@RequestMapping("/test")
	public String testPage(){
		return "WEB-INF/pages/test.html";
	}
}

對(duì)應(yīng)前端頁(yè)面，如下所示（別看他挺多的樣子其實(shí)啥也沒(méi)有，這里主要是將了一個(gè)在springmvc頁(yè)面中也是中文的配置，可以當(dāng)做沒(méi)看見(jiàn)）

<html>
	<head>
		<title>TestPage</title>
	</head>
	<body>
		TestPage, 
		<br/>
		This Page only display English character.
		<br />
		To display chineses character, you should add an encoding filter in web.xml, like this
		<br />
		<br />
		<br />
		&lt;filter&gt;<br />
		&lt;filter-name&gt;encodingFilter&lt;/filter-name&gt;<br />
		&lt;filter-class&gt;org.springframework.web.filter.CharacterEncodingFilter&lt;/filter-class&gt;<br />
		&lt;init-param&gt;<br />
		&nbsp;&nbsp;&nbsp;&nbsp;	&lt;param-name&gt;encoding&lt;/param-name&gt;<br />
		&nbsp;&nbsp;&nbsp;&nbsp;	&lt;param-value&gt;UTF-8&lt;/param-value&gt;<br />
		&lt;/init-param&gt;<br />
		&lt;init-param&gt;<br />
		&nbsp;&nbsp;&nbsp;&nbsp;	&lt;param-name&gt;forceEncoding&lt;/param-name&gt;<br />
		&nbsp;&nbsp;&nbsp;&nbsp;	&lt;param-value&gt;true&lt;/param-value&gt;<br />
		&lt;/init-param&gt;<br />
		&lt;/filter&gt;<br />
		
		&lt;filter-mapping&gt;<br />
		&nbsp;&nbsp;&nbsp;&nbsp;	&lt;filter-name&gt;encodingFilter&lt;/filter-name&gt;<br />
		&nbsp;&nbsp;&nbsp;&nbsp;	&lt;url-pattern&gt;/*&lt;/url-pattern&gt;<br />
		&lt;/filter-mapping&gt;<br />

	</body>
</html>

3.2 Test2Controller 及其頁(yè)面

Test2Controller的代碼

package shirospringweb.controller;

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

@Controller
public class Test2Controller {
	
	@RequestMapping("/test2")
	public String getTest2Page(){
		return "WEB-INF/pages/test2.html";
	}
}

其對(duì)應(yīng)的界面如下：

<html>
	<head>
		Test 2 Page
	</head>
	<body>
		This is the test 2 page <br/>
		(Can not display chinese Character, more information <a href="/app/test" rel="external nofollow" >click here</a>)
	</body>
</html>

3.3 LoginController 及其對(duì)應(yīng)的界面

LoginController的代碼

package shirospringweb.controller;

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


@Controller
public class LoginController {

	@RequestMapping("/login")
	public String getLogin(){
		return "WEB-INF/pages/login.html";
	}
}

其對(duì)應(yīng)的登錄界面

<html>
	<head>Login Page</head>
	<body>
		This is Login Page With No Chinese Character
		<br>
		<form action="/app/login" method="POST">
			username : <input name="username" /><br/>
			password : <input name="password" /><br/>
			<input type="submit" value="LOGIN"/>
		</form>
	</body>
</html>

好了，代碼到這兒完事兒了，下面是運(yùn)行的效果圖

(4).運(yùn)行效果

4.1 首先訪問(wèn)/app/test頁(yè)面可以訪問(wèn)到(shiro未攔截)

頁(yè)面如下

4.2 其實(shí)訪問(wèn)/app/test2需要登錄，登錄后需要后跳轉(zhuǎn)（可能需要訪問(wèn)兩次，有一次請(qǐng)求URL會(huì)帶參數(shù)，這個(gè)shiro會(huì)報(bào)錯(cuò)，這是shiro的問(wèn)題，可以百度解決）具體如下：