以一个springboot项目中创建用户会话的业务背景来说明threadlocal的用法

在Spring Boot项目中，`ThreadLocal` 是一个非常有用的工具，特别是在处理用户会话信息时。`ThreadLocal` 允许你在同一个线程中存储和访问变量，而不会与其他线程的变量发生冲突。这对于存储用户会话信息、请求上下文等非常有用。

以下是一个示例，展示了如何在Spring Boot项目中使用 `ThreadLocal` 来存储和访问用户会话信息：

### 1. 创建一个 `ThreadLocal` 变量

首先，创建一个 `ThreadLocal` 变量来存储用户会话信息。通常，这个变量会被定义为一个静态变量。

public class UserContextHolder {
    private static final ThreadLocal userSessionHolder = new ThreadLocal();
    public static void setUserSession(UserSession userSession) {
        userSessionHolder.set(userSession);
    }
    public static UserSession getUserSession() {
        return userSessionHolder.get();
    }
    public static void clear() {
        userSessionHolder.remove();
    }
}

### 2. 定义用户会话类

定义一个用户会话类来存储用户信息。

public class UserSession {
    private String userId;
    private String username;
    // 其他用户信息
    // 构造函数、getter 和 setter 方法
    public UserSession(String userId, String username) {
        this.userId = userId;
        this.username = username;
    }
    public String getUserId() {
        return userId;
    }
    public void setUserId(String userId) {
        this.userId = userId;
    }
    public String getUsername() {
        return username;
    }
    public void setUsername(String username) {
        this.username = username;
    }
}

### 3. 在拦截器中设置用户会话信息

在Spring Boot中，可以使用拦截器（Interceptor）在请求到达控制器之前设置用户会话信息。

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@Component
public class UserSessionInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 从请求中获取用户会话信息，例如从请求头或Cookie中获取
        String userId = request.getHeader("X-User-Id");
        String username = request.getHeader("X-Username");
        if (userId != null && username != null) {
            UserSession userSession = new UserSession(userId, username);
            UserContextHolder.setUserSession(userSession);
        }
        return true;
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 清理ThreadLocal变量
        UserContextHolder.clear();
    }
}

### 4. 注册拦截器

在Spring Boot中注册拦截器。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Autowired
    private UserSessionInterceptor userSessionInterceptor;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(userSessionInterceptor);
    }
}

### 5. 在业务逻辑中使用用户会话信息

在业务逻辑中，可以通过 `UserContextHolder` 获取用户会话信息。

import org.springframework.stereotype.Service;
@Service
public class UserService {
    public void doSomething() {
        UserSession userSession = UserContextHolder.getUserSession();
        if (userSession != null) {
            String userId = userSession.getUserId();
            String username = userSession.getUsername();
            // 使用用户会话信息进行业务逻辑处理
            System.out.println("User ID: " + userId + ", Username: " + username);
        } else {
            System.out.println("User session not found");
        }
    }
}

### 总结

通过上述步骤，我们可以在Spring Boot项目中使用 `ThreadLocal` 来存储和访问用户会话信息。`ThreadLocal` 确保了每个线程都有自己的用户会话信息副本，避免了线程安全问题，并且使得在业务逻辑中获取用户会话信息变得非常方便。