当前位置:   article > 正文

分布式Session共享的5类技术方案,与优劣势比较

分布式Session共享的5类技术方案,与优劣势比较

分布式Session共享是分布式系统中常见的问题,主要解决在多个服务器之间共享用户会话信息的需求。以下是五种常见的分布式Session共享技术方案及其优劣势比较:

1. Session复制

设计思路:
多个Web服务器之间相互同步Session,每个Web服务器包含全部Session数据。

优点:

  • 应用程序不需要修改代码,实现简单。
  • 当网络中有机器Down掉时不影响用户访问。

缺点:

  • 同步合并过程复杂,广播式复制容易造成同步延迟。
  • 数据量受内存限制,无法水平扩展。
  • 每台服务器都需要备份Session,可能出现内存不够用的情况。

Session复制的实现方案

Session复制是一种在服务器集群中同步Session数据的机制,使得每个服务器都拥有所有用户的Session副本。以下是使用Tomcat和Spring Boot实现Session复制的基本步骤和代码示例。

1. 环境准备
  • Tomcat:作为应用服务器。
  • Spring Boot:用于快速搭建应用。
  • Redis:用于存储Session数据,以便在多个Tomcat实例之间共享。
2. 添加依赖

在Spring Boot项目的pom.xml文件中添加必要的依赖。

<dependencies>
    <!-- Spring Boot Starter Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- Spring Session -->
    <dependency>
        <groupId>org.springframework.session</groupId>
        <artifactId>spring-session-data-redis</artifactId>
    </dependency>
    <!-- Redis Starter -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-redis</artifactId>
    </dependency>
</dependencies>
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
3. 配置Redis

application.propertiesapplication.yml中配置Redis连接信息。

spring.redis.host=localhost
spring.redis.port=6379
  • 1
  • 2
4. 启用Spring Session

在Spring Boot启动类上添加@EnableRedisHttpSession注解,启用Spring Session。

import org.springframework.session.data.redis.config.annotation.web.http.EnableRedisHttpSession;

@EnableRedisHttpSession
@SpringBootApplication
public class SessionReplicationApplication {

    public static void main(String[] args) {
        SpringApplication.run(SessionReplicationApplication.class, args);
    }
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
5. 配置Tomcat集群

server.xml中配置Tomcat集群,启用Session复制功能。

<Cluster className="org.apache.catalina.ha.tcp.SimpleTcpCluster">
    <Manager className="org.apache.catalina.ha.session.DeltaManager" expireSessionsOnShutdown="false" notifyListenersOnReplication="true" />
    <Channel className="org.apache.catalina.tribes.group.GroupChannel">
        <Membership className="org.apache.catalina.tribes.membership.McastService" address="228.0.0.4" port="45564" frequency="500" dropTime="3000" />
        <Receiver className="org.apache.catalina.tribes.transport.nio.NioReceiver" address="auto" port="4000" autoBind="100" selectorTimeout="5000" maxThreads="6" />
        <Sender className="org.apache.catalina.tribes.transport.ReplicationTransmitter">
            <Transport className="org.apache.catalina.tribes.transport.nio.PooledParallelSender" />
        </Sender>
        <Interceptor className="org.apache.catalina.tribes.group.interceptors.TcpFailureDetector" />
        <Interceptor className="org.apache.catalina.tribes.group.interceptors.MessageDispatchInterceptor" />
    </Channel>
    <Valve className="org.apache.catalina.ha.tcp.ReplicationValve" filter="" />
    <Valve className="org.apache.catalina.ha.session.JvmRouteBinderValve" />
    <Deployer className="org.apache.catalina.ha.deploy.FarmWarDeployer" tempDir="/tmp/war-temp/" deployDir="/tmp/war-deploy/" watchDir="/tmp/war-listen/" watchEnabled="false" />
    <ClusterListener className="org.apache.catalina.ha.session.ClusterSessionListener" />
</Cluster>
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
6. 配置Web应用

web.xml中添加<distributable/>标签,启用分布式部署。

<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee 
                             http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
         version="3.1">
    <distributable/>
</web-app>
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7

详细解释

  1. 环境准备:确保有Tomcat和Spring Boot环境。
  2. 添加依赖:在Spring Boot项目中添加必要的依赖,包括Spring Session和Redis。
  3. 配置Redis:配置Redis的连接信息,以便Spring Session可以存储Session数据。
  4. 启用Spring Session:通过@EnableRedisHttpSession注解启用Spring Session,并将Session数据存储在Redis中。
  5. 配置Tomcat集群:在server.xml中配置Tomcat集群,启用Session复制功能。这包括配置Cluster、Manager、Channel等组件。
  6. 配置Web应用:在web.xml中添加<distributable/>标签,确保Web应用在分布式环境下可以正确运行。

通过这种方式,每个Tomcat实例都会将Session数据同步到Redis中,从而实现在多个服务器之间共享Session数据。这样,即使用户的请求被分发到不同的服务器,也能访问到一致的Session数据。

2. Session存储在Cookie

设计思路:
将Session数据加密后存储在Cookie中。

优点:

  • 简单易实现。
  • 不需要考虑数据同步,服务端不需要存储Session数据。

缺点:

  • 不安全,数据有被破解的风险。
  • Cookie的存储容量较小,只适用于Session数据量小的场景。
  • 每次请求响应都需要传递Cookie,影响性能,如果用户关闭Cookie,访问就不正常。

Session存储在Cookie的实现方案

将Session信息存储在Cookie中是一种简单且常见的分布式Session共享方法。这种方式将用户的会话信息加密后存储在客户端的Cookie中,每次请求时携带这些信息,服务器通过解析Cookie来恢复会话状态。

1. 环境准备
  • Spring Boot:用于快速搭建应用。
  • Thymeleaf:用于生成动态HTML页面(可选)。
2. 添加依赖

在Spring Boot项目的pom.xml文件中添加必要的依赖。

<dependencies>
    <!-- Spring Boot Starter Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- Thymeleaf -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-thymeleaf</artifactId>
    </dependency>
</dependencies>
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
3. 创建登录逻辑

在Spring Boot应用中创建一个控制器,处理用户的登录请求,并在成功登录后将用户信息存储在Cookie中。

import org.springframework.web.bind.annotation.*;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletResponse;

@RestController
public class LoginController {

    @PostMapping("/login")
    public String login(@RequestParam String username, HttpServletResponse response) {
        String sessionId = UUID.randomUUID().toString();
        String encryptedSessionData = encryptSessionData(username);

        // 创建Cookie并设置加密的Session数据
        Cookie cookie = new Cookie("JSESSIONID", encryptedSessionData);
        cookie.setHttpOnly(true); // 增加安全性,禁止JavaScript访问Cookie
        cookie.setPath("/"); // Cookie对整个应用有效
        response.addCookie(cookie);

        return "Logged in with session ID: " + sessionId;
    }

    private String encryptSessionData(String username) {
        // 这里使用简单的Base64编码作为示例,实际应用中应使用更安全的加密算法
        return Base64.getEncoder().encodeToString(username.getBytes());
    }
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
4. 创建登出逻辑

处理用户的登出请求,并清除Cookie中的Session信息。

import org.springframework.web.bind.annotation.*;

import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@RestController
public class LogoutController {

    @GetMapping("/logout")
    public String logout(HttpServletRequest request, HttpServletResponse response) {
        Cookie[] cookies = request.getCookies();
        if (cookies != null) {
            for (Cookie cookie : cookies) {
                if ("JSESSIONID".equals(cookie.getName())) {
                    cookie.setMaxAge(0); // 清除Cookie
                    cookie.setPath("/"); // 确保Cookie被正确清除
                    response.addCookie(cookie);
                }
            }
        }
        return "Logged out";
    }
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
5. 创建首页和登录页面

使用Thymeleaf创建首页和登录页面。

  • login.html
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Login Page</title>
</head>
<body>
    <h2>Login</h2>
    <form action="/login" method="post">
        <label for="username">Username:</label>
        <input type="text" id="username" name="username" required>
        <button type="submit">Login</button>
    </form>
</body>
</html>
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • home.html
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Home Page</title>
</head>
<body>
    <h1>Welcome to the Home Page</h1>
    <a href="/logout">Logout</a>
</body>
</html>
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11

详细解释

  1. 环境准备:使用Spring Boot和Thymeleaf搭建基本的Web应用。
  2. 添加依赖:在项目的pom.xml中添加Spring Web和Thymeleaf的依赖。
  3. 创建登录逻辑:在控制器中处理登录请求,将用户信息加密后存储在Cookie中。这里使用Base64编码作为示例,实际应用中应使用更安全的加密算法。
  4. 创建登出逻辑:处理登出请求,清除Cookie中的Session信息。
  5. 创建首页和登录页面:使用Thymeleaf模板生成动态HTML页面,提供登录和登出的界面。

注意

  • 将Session信息存储在Cookie中可能会带来安全性问题,因此需要对存储的数据进行加密。
  • Cookie的大小限制为4KB,因此不适合存储大量数据。
  • 每次请求都需要携带Cookie,可能会影响性能。

通过这种方式,用户的会话信息在客户端和服务器之间传递,实现了分布式环境下的Session共享。

3. Session粘性方式管理

设计思路:
利用负载均衡器的分发能力,将同一浏览器上同一用户的请求定向发送到固定服务器上。

优点:

  • 只需要修改Nginx配置,不需要修改应用代码。
  • 可以实现会话的粘性,减少Session丢失的风险。

缺点:

  • 机器Down掉时用户Session会丢失,容易造成单点故障。
  • 不符合对系统的高可用要求。

Session粘性方式管理的实现方案

Session粘性(也称为会话粘滞性或会话亲和性)是一种通过负载均衡器确保同一用户的请求始终被路由到同一服务器的技术。这可以通过负载均衡器的配置实现,而不是在应用代码中处理。以下是使用Nginx实现Session粘性的步骤和代码示例。

1. 环境准备
  • Nginx:作为反向代理和负载均衡器。
  • Tomcat:作为应用服务器。
2. 配置Nginx

在Nginx的配置文件中(通常是nginx.confdefault.conf),配置负载均衡器并启用Session粘性。

http {
    upstream backend {
        server tomcat1.example.com;
        server tomcat2.example.com;
        server tomcat3.example.com;

        # 启用Session粘性
        sticky;
        sticky cookie cookie_name;
    }

    server {
        listen 80;

        location / {
            proxy_pass http://backend;

            # 配置负载均衡器的其他参数
            proxy_set_header Host $host;
            proxy_set_header X-Real-IP $remote_addr;
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
            proxy_set_header X-Forwarded-Proto $scheme;
        }
    }
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25

参数说明

  • upstream backend:定义了一个服务器组。
  • server:定义了服务器组中的各个服务器。
  • sticky:启用Session粘性。
  • sticky cookie cookie_name:指定用于Session粘性的Cookie名称。
3. 配置Tomcat

确保Tomcat服务器能够处理来自Nginx的请求。在server.xml中配置Tomcat的端口和应用路径。

<Server port="8005" shutdown="SHUTDOWN">
    <Connector port="8080" protocol="HTTP/1.1" 
               connectionTimeout="20000" 
               redirectPort="8443" />
    <Host name="localhost"  appBase="webapps" 
          unpackWAR="true" autoDeploy="true">
        <Context path="" docBase="app" reloadable="true" />
    </Host>
</Server>
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
4. 应用代码

在Spring Boot应用中,创建一个控制器来处理用户的登录和登出请求,并在成功登录后设置一个Cookie。

import org.springframework.web.bind.annotation.*;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletResponse;

@RestController
public class SessionController {

    @PostMapping("/login")
    public String login(@RequestParam String username, HttpServletResponse response) {
        // 创建Cookie并设置用户名
        Cookie cookie = new Cookie("JSESSIONID", username);
        cookie.setPath("/"); // Cookie对整个应用有效
        cookie.setMaxAge(60 * 60 * 24); // 设置Cookie有效期为1天
        response.addCookie(cookie);

        return "Logged in with session ID: " + username;
    }

    @GetMapping("/logout")
    public String logout(HttpServletRequest request, HttpServletResponse response) {
        Cookie[] cookies = request.getCookies();
        if (cookies != null) {
            for (Cookie cookie : cookies) {
                if ("JSESSIONID".equals(cookie.getName())) {
                    cookie.setMaxAge(0); // 清除Cookie
                    cookie.setPath("/"); // 确保Cookie被正确清除
                    response.addCookie(cookie);
                }
            }
        }
        return "Logged out";
    }
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
5. 创建首页和登录页面

使用Thymeleaf创建首页和登录页面。

  • login.html
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Login Page</title>
</head>
<body>
    <h2>Login</h2>
    <form action="/login" method="post">
        <label for="username">Username:</label>
        <input type="text" id="username" name="username" required>
        <button type="submit">Login</button>
    </form>
</body>
</html>
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • home.html
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Home Page</title>
</head>
<body>
    <h1>Welcome to the Home Page</h1>
    <a href="/logout">Logout</a>
</body>
</html>
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11

详细解释

  1. 环境准备:使用Nginx作为负载均衡器,Tomcat作为应用服务器。
  2. 配置Nginx:在Nginx配置文件中定义服务器组,并启用Session粘性。通过sticky指令和sticky cookie指令指定用于粘性的Cookie。
  3. 配置Tomcat:确保Tomcat服务器能够接收来自Nginx的请求,并正确处理请求。
  4. 应用代码:在Spring Boot应用中,创建控制器处理登录和登出请求,并在登录时设置一个Cookie。这个Cookie将被Nginx用于Session粘性。
  5. 创建首页和登录页面:使用Thymeleaf模板生成动态HTML页面,提供登录和登出的界面。

注意

  • Session粘性依赖于客户端的Cookie,因此如果用户禁用了Cookie,Session粘性将无法工作。
  • 需要确保所有服务器的时钟同步,以避免由于时钟不同步导致的Session不一致问题。
  • 此方法不适用于无状态的微服务架构,因为它依赖于服务器与客户端之间的状态(即Cookie)。

4. Session集中管理在后端

设计思路:
Session存储在数据库或缓存(如Redis、Memcached)中。

优点:

  • 实现起来相对简单,效率很高。
  • 安全性较好,支持水平扩展。
  • 中大型网站的首选方案。

缺点:

  • 需要修改应用代码,将原本的Session访问逻辑改为访问后端存储。
  • 增加了一次网络调用,速度有所下降。

Session集中管理在后端的实现方案

集中管理Session在后端是一种常见的分布式Session共享方法,通常使用缓存系统如Redis来存储Session数据。这种方式将所有用户的Session信息存储在集中的缓存系统中,而不是分散在各个应用服务器上。以下是使用Spring Boot和Redis实现Session集中管理的步骤和代码示例。

1. 环境准备
  • Spring Boot:用于快速搭建应用。
  • Redis:作为集中存储Session的缓存系统。
2. 添加依赖

在Spring Boot项目的pom.xml文件中添加必要的依赖。

<dependencies>
    <!-- Spring Boot Starter Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- Spring Session Data Redis -->
    <dependency>
        <groupId>org.springframework.session</groupId>
        <artifactId>spring-session-data-redis</artifactId>
    </dependency>
    <!-- Spring Boot Starter Data Redis -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-redis</artifactId>
    </dependency>
</dependencies>
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
3. 配置Redis

application.propertiesapplication.yml中配置Redis连接信息。

spring.redis.host=localhost
spring.redis.port=6379
  • 1
  • 2
4. 启用Spring Session

在Spring Boot启动类上添加@EnableRedisHttpSession注解,启用Spring Session。

import org.springframework.session.data.redis.config.annotation.web.http.EnableRedisHttpSession;

@EnableRedisHttpSession
@SpringBootApplication
public class SessionManagementApplication {

    public static void main(String[] args) {
        SpringApplication.run(SessionManagementApplication.class, args);
    }
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
5. 创建登录逻辑

在Spring Boot应用中创建一个控制器,处理用户的登录请求,并在成功登录后将用户信息存储在Session中。

import org.springframework.web.bind.annotation.*;
import javax.servlet.http.HttpSession;

@RestController
public class LoginController {

    @PostMapping("/login")
    public String login(@RequestParam String username, HttpSession session) {
        session.setAttribute("username", username);
        return "Logged in with username: " + username;
    }
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
6. 创建登出逻辑

处理用户的登出请求,并清除Session中的信息。

import org.springframework.web.bind.annotation.*;

import javax.servlet.http.HttpSession;

@RestController
public class LogoutController {

    @GetMapping("/logout")
    public String logout(HttpSession session) {
        session.invalidate();
        return "Logged out";
    }
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
7. 创建首页和登录页面

使用Thymeleaf创建首页和登录页面。

  • login.html
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Login Page</title>
</head>
<body>
    <h2>Login</h2>
    <form action="/login" method="post">
        <label for="username">Username:</label>
        <input type="text" id="username" name="username" required>
        <button type="submit">Login</button>
    </form>
</body>
</html>
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • home.html
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Home Page</title>
</head>
<body>
    <h1>Welcome to the Home Page</h1>
    <form action="/logout" method="get">
        <button type="submit">Logout</button>
    </form>
</body>
</html>
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13

详细解释

  1. 环境准备:使用Spring Boot和Redis搭建基本的Web应用。
  2. 添加依赖:在项目的pom.xml中添加Spring Web、Spring Session Data Redis和Spring Data Redis的依赖。
  3. 配置Redis:配置Redis的连接信息,以便Spring Session可以存储Session数据。
  4. 启用Spring Session:通过@EnableRedisHttpSession注解启用Spring Session,并将Session数据存储在Redis中。
  5. 创建登录逻辑:在控制器中处理登录请求,将用户信息存储在Session中。Spring Session会自动将Session数据存储到Redis。
  6. 创建登出逻辑:处理登出请求,清除Session中的信息。Spring Session会从Redis中删除对应的Session数据。
  7. 创建首页和登录页面:使用Thymeleaf模板生成动态HTML页面,提供登录和登出的界面。

注意

  • 这种方式通过Spring Session自动管理Session的存储和过期,简化了应用代码。
  • 需要确保Redis服务的高可用性和安全性,因为所有的Session数据都存储在Redis中。
  • 这种方式不依赖于Cookie,因此适用于无状态的微服务架构。

5. 使用Token代替Session

设计思路:
使用JSON Web Token(JWT)代替传统的Session。

优点:

  • 无状态、可扩展,负载均衡器能够将用户信息从一个服务传到其他服务器上。
  • 安全性高,请求中发送Token而不再是发送Cookie能够防止CSRF(跨站请求伪造)。
  • 多平台跨域,适用于单点登录(SSO)和用户服务器等场景。

缺点:

  • 实现复杂,需要开发专门的Token管理平台。
  • Token的安全性依赖于密钥管理和Token的有效期管理。

通过以上方案的比较,可以根据不同业务需求和技术背景选择合适的分布式Session共享方案。

使用Token代替Session的实现方案

使用Token代替Session是一种现代的身份验证方法,其中JSON Web Tokens (JWT) 是最常用的实现方式。Token通常在用户登录后生成,并在用户进行后续请求时发送到服务器。以下是使用Spring Boot和JWT实现Token认证的步骤和代码示例。

1. 环境准备
  • Spring Boot:用于快速搭建应用。
  • Java JWT library:例如jjwt,用于生成和验证JWT。
2. 添加依赖

在Spring Boot项目的pom.xml文件中添加JWT库的依赖。

<dependencies>
    <!-- Spring Boot Starter Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- JWT library -->
    <dependency>
        <groupId>io.jsonwebtoken</groupId>
        <artifactId>jjwt</artifactId>
        <version>0.9.1</version> <!-- 请使用最新版本 -->
    </dependency>
</dependencies>
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
3. 创建JWT工具类

创建一个工具类来生成和解析JWT。

import io.jsonwebtoken.Claims;
import io.jsonwebtoken.Jwts;
import io.jsonwebtoken.SignatureAlgorithm;

import java.util.Date;
import java.util.function.Function;

public class JwtUtils {

    private static final String SECRET_KEY = "your-secret-key"; // 应从配置文件或环境变量中安全地获取

    public static String generateToken(String username) {
        return Jwts.builder()
                .setSubject(username)
                .setIssuedAt(new Date(System.currentTimeMillis()))
                .setExpiration(new Date(System.currentTimeMillis() + 1000 * 60 * 60 * 10)) // 10小时后过期
                .signWith(SignatureAlgorithm.HS256, SECRET_KEY)
                .compact();
    }

    public static String getUserNameFromToken(String token) {
        return Jwts.parser()
                .setSigningKey(SECRET_KEY)
                .parseClaimsJws(token)
                .getBody()
                .getSubject();
    }

    public static boolean validateToken(String token) {
        try {
            Jwts.parser().setSigningKey(SECRET_KEY).parseClaimsJws(token);
            return true;
        } catch (io.jsonwebtoken.security.SecurityException | MalformedJwtException e) {
            return false;
        }
    }
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
4. 创建登录逻辑

在Spring Boot应用中创建一个控制器,处理用户的登录请求,并在成功登录后生成JWT。

import org.springframework.web.bind.annotation.*;
import io.jsonwebtoken.Jwts;

import javax.servlet.http.HttpServletResponse;

@RestController
public class AuthController {

    @PostMapping("/login")
    public String login(@RequestParam String username, HttpServletResponse response) {
        String token = JwtUtils.generateToken(username);
        response.addHeader("Authorization", "Bearer " + token);
        return "Logged in with token";
    }
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
5. 创建Token验证过滤器

创建一个过滤器,用于验证传入的Token。

import org.springframework.web.filter.OncePerRequestFilter;

import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

public class JwtFilter extends OncePerRequestFilter {

    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
            throws ServletException, IOException {
        String authHeader = request.getHeader("Authorization");
        if (authHeader != null && authHeader.startsWith("Bearer ")) {
            String token = authHeader.substring(7);
            if (JwtUtils.validateToken(token)) {
                filterChain.doFilter(request, response);
            } else {
                response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
            }
        } else {
            response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
        }
    }
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
6. 注册过滤器

注册JwtFilter以确保所有受保护的请求都经过Token验证。

import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class JwtConfig {

    @Bean
    public FilterRegistrationBean jwtFilter() {
        FilterRegistrationBean registrationBean = new FilterRegistrationBean();
        registrationBean.setFilter(new JwtFilter());
        registrationBean.addUrlPatterns("/api/*"); // 所有/api下的请求都需要验证Token
        return registrationBean;
    }
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
7. 创建受保护的API

创建一个受保护的API,只有验证Token后才可访问。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class SecureController {

    @GetMapping("/secure/data")
    public String secureData() {
        return "Secure data for user: " + JwtUtils.getUserNameFromToken("from-request");
    }
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11

详细解释

  1. 环境准备:使用Spring Boot搭建基本的Web应用,并选择一个JWT库。
  2. 添加依赖:在项目的pom.xml中添加JWT库的依赖。
  3. 创建JWT工具类:提供生成、验证和解析JWT的方法。
  4. 创建登录逻辑:在控制器中处理登录请求,并生成JWT,将其发送到响应头中。
  5. 创建Token验证过滤器:创建一个过滤器来验证每个请求中的Token。
  6. 注册过滤器:配置过滤器以拦截特定的请求路径。
  7. 创建受保护的API:创建一个API,只有Token验证通过后才返回数据。

注意

  • Token(如JWT)通常包含用户身份信息,不应包含敏感数据。
  • 应使用HTTPS来保护Token在传输过程中的安全。
  • Token的安全性依赖于密钥(SECRET_KEY),该密钥应安全存储,不应硬编码在代码中。
  • JWT一旦发出,就无法撤销,因此需要设置合理的过期时间。

最后

5种分布式Session共享实现方案该如何选择呢?

如何选择

选择适合的分布式Session共享方案时,我们需要考虑以下因素:

  1. 系统规模

    • 小型系统或初期阶段可能更适合使用Session复制或Session存储在Cookie。
    • 大型系统或需要高可用性的系统应考虑Session集中管理在后端或使用Token。
  2. 安全性要求

    • 对安全性要求较高的系统应避免使用Session存储在Cookie,考虑使用Token或集中管理Session。
  3. 开发和维护成本

    • Session复制和Session存储在Cookie实现简单,但可能带来维护复杂性。
    • 使用Token需要开发Token管理平台,但长期维护成本可能较低。
  4. 性能考虑

    • Session复制和Session存储在Cookie可能会影响性能,尤其是在大规模集群中。
    • 使用Token和集中管理Session可以减少服务器间的通信,提高性能。
  5. 可扩展性

    • 使用Token和集中管理Session更容易实现水平扩展和负载均衡。
  6. 跨域支持

    • 使用Token可以更好地支持跨域和多平台访问。
  7. 技术栈和偏好

    • 根据团队的技术栈和偏好选择合适的方案,例如使用Spring Boot和Redis的组合。

通过综合考虑这些因素,可以为特定业务场景选择最合适的分布式Session共享方案。

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/木道寻08/article/detail/858413
推荐阅读
相关标签
  

闽ICP备14008679号