寫了這么多年代碼，這樣的登錄方式還是頭一回見！

作者：江南一點雨 2020-07-03 08:11:33

Spring Security 系列還沒搞完，最近還在研究。有的時候我不禁想，如果從 Spring Security 誕生的第一天開始，我們就一直在追蹤它，那么今天再去看它的源碼一定很簡單，因為我們了解到每一行代碼的緣由。

Spring Security 系列還沒搞完，最近還在研究。

有的時候我不禁想，如果從 Spring Security 誕生的第一天開始，我們就一直在追蹤它，那么今天再去看它的源碼一定很簡單，因為我們了解到每一行代碼的緣由。

然而事實上我們大部分人都是中途接觸到它的，包括松哥自己。所以在閱讀源碼的時候，有時候會遇到一些不是那么容易理解的東西，并不是說這個有多難，只是我們不了解 N 年前的開發環境，因此也就不容易理解某一行代碼出現的意義。

所以為了搞透徹這個框架，有時候我們還得去了解之前發生了什么。

這就跟學 Spring Boot 一樣，很多小伙伴問要不要跳過 SSM ，我說不要，甚至還專門寫了一篇文章(Spring Boot 要怎么學?要學哪些東西?要不要先學 SSM?)，跳過了 SSM ，Spring Boot 中的很多東西就無法真正理解。

扯遠了。。。

Spring Security 中對 HttpServletRequest 請求進行了封裝，重寫了 HttpServletRequest 中的幾個和安全管理相關的方法，想要理解 Spring Security 中的重寫，就要先從 HttpServletRequest 開始看起。

有小伙伴可能會說，HttpServletRequest 能跟安全管理扯上什么關系?今天松哥就來和大家捋一捋，我們不講 Spring Security，就來單純講講 HttpServletRequest 中的安全管理方法。

1.HttpServletRequest

在 HttpServletRequest 中，我們常用的方法如：

public String getHeader(String name);
public String getParameter(String name);
public ServletInputStream getInputStream()
...

這些常見的方法可能大家都有用過，還有一些不常見的，和安全相關的方法：

public String getRemoteUser(); 
public boolean isUserInRole(String role); 
public java.security.Principal getUserPrincipal(); 
public boolean authenticate(HttpServletResponse response) 
            throws IOException, ServletException; 
public void login(String username, String password) throws ServletException; 
public void logout() throws ServletException;

前面三個方法，在之前的 Servlet 中就有，后面三個方法，則是從 Servlet3.0 開始新增加的方法。從方法名上就可以看出，這些都是和認證相關的方法，但是這些方法，我估計很多小伙伴都沒用過，因為不太實用。

在 Spring Security 框架中，對這些方法進行了重寫，進而帶來了一些好玩并且方便的特性，這個松哥在后面的文章中再和大家分享。

要理解 Spring Security 中的封裝，就得先來看看，不用框架，這些方法該怎么用!

2.實踐出真

知我們創建一個普普通通的 Web 項目，不使用任何框架(后面的案例都基于此)，然后在 doGet 方法中打印出 HttpServletRequest 的類型，代碼如下：

@Override 
protected void doGet(HttpServletRequest request, HttpServletResponse resp) throws ServletException, IOException { 
    System.out.println("request.getClass() = " + request.getClass()); 
}

代碼運行打印結果如下：

request.getClass() = class org.apache.catalina.connector.RequestFacade

HttpServletRequest 是一個接口，而 RequestFacade 則是一個正兒八經的 class。

HttpServletRequest 是 Servlet 規范中定義的 ServletRequest，這相當于是標準的 Request;但是在 Tomcat 中的 Request 則是 Tomcat 自己自定義的 Request，自定義的 Request 實現了 HttpServletRequest 接口并且還定義了很多自己的方法，這些方法還是 public 的，如果直接使用 Tomcat 自定義的 Request，開發者只需要向下轉型就能調用這些 Tomcat 內部方法，這是有問題的，所以又用 RequestFacade 封裝了一下，以至于我們實際上用到的就是 RequestFacade 對象。

那么毫無疑問，HttpServletRequest#login 方法具體實現就是在 Tomcat 的 Request#login 方法中完成的。經過源碼追蹤，我們發現，登錄的數據源是由 Tomcat 中的 Realm 提供的，注意這個 Realm 不是 Shiro 中的 Realm。

Tomcat 中提供了 6 種 Realm，可以支持與各種數據源的對接：

JDBCRealm：很明顯，這個 Realm 可以對接到數據庫中的用戶信息。
DataSourceRealm：它通過一個 JNDI 命名的 JDBC 數據源在關系型數據庫中查找用戶。
JNDIRealm：通過一個 JNDI 提供者1在 LDAP 目錄服務器中查找用戶。
UserDatabaseRealm：這個數據源在 Tomcat 的配置文件中 conf/tomcat-users.xml。
MemoryRealm：這個數據源是在內存中，內存中的數據也是從 conf/tomcat-users.xml 配置文件中加載的。
JAASRealm：JAAS 架構來實現對用戶身份的驗證。

如果這些 Realm 無法滿足需求，當然我們也可以自定義 Realm，只不過一般我們不這樣做，為啥?因為這這種登錄方式用的太少了!今天這篇文章純粹是和小伙伴們開開眼界。

如果自定義 Realm 的話，我們只需要實現 org.apache.catalina.Realm 接口，然后將編譯好的 jar 放到 $CATALINA_HOME/lib 下即可，具體的配置則和下面介紹的一致。

接下來我和大家介紹兩種配置方式，一個是 UserDatabaseRealm，另一個是 JDBCRealm。

2.1 基于配置文件登錄

我們先來定義一個 LoginServlet：

@WebServlet(urlPatterns = "/login") 
public class LoginServlet extends HttpServlet { 
    @Override 
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { 
        doPost(req, resp); 
    } 
 
    @Override 
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { 
        String username = req.getParameter("username"); 
        String password = req.getParameter("password"); 
        try { 
            req.login(username, password); 
        } catch (ServletException e) { 
            req.getRequestDispatcher("/login.jsp").forward(req, resp); 
            return; 
        } 
        boolean login = req.getUserPrincipal() != null && req.isUserInRole("admin"); 
        if (login) { 
            resp.sendRedirect("/hello"); 
            return; 
        } else { 
            req.getRequestDispatcher("/login.jsp").forward(req, resp); 
        } 
    } 
}

當請求到達后，先提取出用戶名和密碼，然后調用 req.login 方法進行登錄，如果登錄失敗，則跳轉到登錄頁面。

登錄完成后，通過獲取登錄用戶信息以及判斷登錄用戶角色，來確保用戶是否登錄成功。

如果登錄成功，就跳轉到項目應用首頁，否則就跳轉到登錄頁面。

接下來定義 HelloServlet：

@WebServlet(urlPatterns = "/hello") 
public class HelloServlet extends HttpServlet { 
    @Override 
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { 
        doPost(req,resp); 
    } 
 
    @Override 
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { 
        Principal userPrincipal = req.getUserPrincipal(); 
        if (userPrincipal == null) { 
            resp.setStatus(401); 
            resp.getWriter().write("please login"); 
        } else if (!req.isUserInRole("admin")) { 
            resp.setStatus(403); 
            resp.getWriter().write("forbidden"); 
        }else{ 
            resp.getWriter().write("hello"); 
        } 
    } 
}

在 HelloServlet 中，先判斷用戶是否已經登錄，沒登錄的話，就返回 401，已經登錄但是不具備相應的角色，就返回 403，否則就返回 hello。

接下來再定義 LogoutServlet，執行注銷操作：

@WebServlet(urlPatterns = "/logout") 
public class LogoutServlet extends HttpServlet { 
    @Override 
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { 
        doPost(req,resp); 
    } 
 
    @Override 
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { 
        req.logout(); 
        resp.sendRedirect("/hello"); 
    } 
}

logout 方法也是 HttpServletRequest 自帶的。

最后再簡單定義一個 login.jsp 頁面，如下：

<%@ page contentType="text/html;charset=UTF-8" language="java" %> 
<html> 
<head> 
    <title>Title</title> 
</head> 
<body> 
<form action="/login" method="post"> 
    <input type="text" name="username"> 
    <input type="text" name="password"> 
    <input type="submit" value="登錄"> 
</form> 
</body> 
</html>

所有工作都準備好了，接下來就是數據源了，默認情況下加載的是 conf/tomcat-users.xml 中的數據，找到 Tomcat 的這個配置文件，修改之后內容如下：

<?xml version="1.0" encoding="UTF-8"?> 
<tomcat-users> 
    <role rolename="admin"/> 
    <user username="javaboy" password="123" roles="admin"/> 
</tomcat-users>

配置完成后，啟動項目進行測試。登錄用戶名是 javaboy，登錄密碼是 123，具體的測試過程我就不再演示了。

2.2 基于數據庫登錄

如果想基于數據庫登錄，我們需要先準備好數據庫和表，需要兩張表，user 表和 role 表，如下：

CREATE TABLE `user` ( 
  `id` int(11) unsigned NOT NULL AUTO_INCREMENT, 
  `username` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL, 
  `password` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL, 
  PRIMARY KEY (`id`) 
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci; 
CREATE TABLE `role` ( 
  `id` int(11) unsigned NOT NULL AUTO_INCREMENT, 
  `username` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL, 
  `role_name` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL, 
  PRIMARY KEY (`id`) 
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;

然后向表中添加兩行模擬數據：

接下來，找到 Tomcat 的 conf/server.xml 文件，修改配置，如下：

<Realm className="org.apache.catalina.realm.LockOutRealm"> 
  <Realm  className="org.apache.catalina.realm.JDBCRealm" debug="99" 
        driverName="com.mysql.jdbc.Driver" 
        connectionURL="jdbc:mysql://localhost:3306/basiclogin" 
        connectionName="root" connectionPassword="123" 
        userTable="user" userNameCol="username"     
        userCredCol="password" 
        userRoleTable="role" roleNameCol="role_name" /> 
</Realm>

在這段配置中：

指定 JDBCRealm。
指定數據庫驅動。
指定數據庫連接地址。
指定數據庫連接用戶名/密碼。
指定用戶表名稱;用戶名的字段名以及密碼字段名。
指定角色表名稱;以及角色字段名。

配置完成后，再次登錄測試，此時的登錄數據就是來自數據庫的數據了。

3.優化

前面的 HelloServlet，我們是在代碼中手動配置的，要是每個 Servlet 都這樣配置，這要搞到猴年馬月了～

所以我們對此可以在 web.xml 中進行手動配置。

首先我們創建一個 AdminServlet 進行測試，如下：

@WebServlet(urlPatterns = "/admin/hello") 
public class AdminServlet extends HttpServlet { 
    @Override 
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { 
        resp.getWriter().write("hello admin!"); 
    } 
}

然后在 web.xml 中進行配置：

<security-constraint> 
    <web-resource-collection> 
        <web-resource-name>admin</web-resource-name> 
        <url-pattern>/admin/*</url-pattern> 
    </web-resource-collection> 
    <auth-constraint> 
        <role-name>admin</role-name> 
    </auth-constraint> 
</security-constraint> 
<security-role> 
    <role-name>admin</role-name> 
</security-role>

這個配置表示 /admin/* 格式的請求路徑，都需要具有 admin 角色才能訪問，否則就訪問不到，這樣，每一個 Admin 相關的 Servlet 就被保護起來了，不用在 Servlet 中寫代碼判斷了。

4.小結

好啦，經過本文的介紹，相信小伙伴們對于 HttpServletRequest 中關于認證的幾個方法基本上都了解了，接下來的文章松哥將繼續和大家介紹這些方法在 Spring Security 框架中是如何進行演化的，看懂了本文，后面的文章就很好理解了～

本文案例下載地址：https://github.com/lenve/javaboy-code-samples

本文轉載自微信公眾號「江南一點雨」，可以通過以下二維碼關注。轉載本文請聯系江南一點雨公眾號。

責任編輯：武曉燕來源：江南一點雨

代碼登錄方式

寫了這么多年代碼，這樣的登錄方式還是頭一回見！

寫了這么多年代碼，這樣的登錄方式還是頭一回見！