Spring Boot 实战篇（十五）：使用 ThreadLocal 优化获取用户详细信息

目录

Spring Boot 实战篇（十五）：使用 ThreadLocal 优化获取用户详细信息

一、理解 ThreadLocal

二、实现步骤及代码

（一）创建线程局部变量

（二）在合适的位置设置用户信息到 ThreadLocal

（三）在需要获取用户信息的地方从 ThreadLocal 获取

（四）注意及时清理 ThreadLocal 中的用户信息

---

在 Web 应用程序中，频繁获取用户详细信息可能会对性能产生一定影响。为了提高效率，我们可以使用 ThreadLocal 来缓存用户信息，避免重复查询数据库或其他数据源。以下将详细介绍使用 ThreadLocal 优化获取用户详细信息功能的步骤，并附上相应的代码示例。

一、理解 ThreadLocal

ThreadLocal 是 Java 中的一个类，它提供了线程局部变量的功能。每个线程都可以独立地访问和修改自己的线程局部变量副本，而不会影响其他线程的副本。在获取用户详细信息的场景中，我们可以利用 ThreadLocal 在同一个线程的多次请求中缓存用户信息，减少不必要的查询操作。

二、实现步骤及代码

（一）创建线程局部变量

1. 定义 ThreadLocal 对象
   • 在合适的类中（例如可以创建一个工具类）定义一个 ThreadLocal 对象来存储用户信息。假设创建一个名为UserContext的类，在其中定义 ThreadLocal 变量。
   • 代码示例：

package com.example.myproject.utils;

import com.example.myproject.entity.UserDetails;

public class UserContext {
    private static final ThreadLocal<UserDetails> userThreadLocal = new ThreadLocal<>();

    public static void setUser(UserDetails user) {
        userThreadLocal.set(user);
    }

    public static UserDetails getUser() {
        return userThreadLocal.get();
    }

    public static void removeUser() {
        userThreadLocal.remove();
    }
}

• 这里定义了一个静态的 ThreadLocal 变量userThreadLocal，并提供了设置、获取和移除用户信息的静态方法。

（二）在合适的位置设置用户信息到 ThreadLocal

1. 在登录或认证成功后设置用户信息
   • 当用户登录或认证成功后，获取用户的详细信息，并将其设置到 ThreadLocal 中。例如，在UserController的登录方法中，在用户登录成功后设置用户信息。
   • 代码示例（简化版登录方法）：

package com.example.myproject.controller;

import com.example.myproject.entity.UserDetails;
import com.example.myproject.service.UserService;
import com.example.myproject.utils.UserContext;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {
    @Autowired
    private UserService userService;

    @PostMapping("/login")
    public ResponseEntity<?> login(@RequestBody UserLoginRequest request) {
        UserDetails userDetails = userService.login(request.getUsername(), request.getPassword());
        if (userDetails!= null) {
            UserContext.setUser(userDetails);
            return new ResponseEntity<>("登录成功", HttpStatus.OK);
        } else {
            return new ResponseEntity<>("登录失败", HttpStatus.UNAUTHORIZED);
        }
    }
}

• 这里假设UserService的login方法返回用户详细信息，登录成功后将用户信息设置到 ThreadLocal 中。

（三）在需要获取用户信息的地方从 ThreadLocal 获取

1. 在业务逻辑中获取用户信息
   • 在其他需要使用用户信息的地方，直接从 ThreadLocal 中获取用户信息。例如，在文章管理的服务层方法中，如果需要记录文章创建者的信息，可以从 ThreadLocal 中获取用户信息。
   • 代码示例（在ArticleService的createArticle方法中）：

package com.example.myproject.service.impl;

import com.example.myproject.dao.ArticleDao;
import com.example.myproject.entity.Article;
import com.example.myproject.entity.UserDetails;
import com.example.myproject.service.ArticleService;
import com.example.myproject.utils.UserContext;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.Date;

@Service
public class ArticleServiceImpl implements ArticleService {
    @Autowired
    private ArticleDao articleDao;

    @Override
    public boolean createArticle(Article article) {
        UserDetails userDetails = UserContext.getUser();
        if (userDetails!= null) {
            article.setAuthor(userDetails.getUsername());
            article.setCreateTime(new Date());
            return articleDao.insertArticle(article) > 0;
        } else {
            // 处理用户信息未获取到的情况，例如抛出异常或记录日志
            throw new RuntimeException("无法获取用户信息，文章创建失败");
        }
    }
}

• 这里从 ThreadLocal 中获取用户信息，并设置文章的作者和创建时间。

（四）注意及时清理 ThreadLocal 中的用户信息

1. 在请求结束或用户登出时清理信息
   • 为了避免内存泄漏，在请求结束或用户登出时，需要及时清理 ThreadLocal 中的用户信息。例如，可以在拦截器或过滤器中进行清理操作。假设创建一个LogoutInterceptor拦截器，在用户登出时清理用户信息。
   • 代码示例：

package com.example.myproject.interceptor;

import com.example.myproject.utils.UserContext;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class LogoutInterceptor implements HandlerInterceptor {
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        UserContext.removeUser();
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    }

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        return true;
    }
}

• 这里在afterCompletion方法中调用UserContext的removeUser方法清理用户信息。同时，需要将该拦截器注册到 Spring 的配置中，例如在WebMvcConfigurer的实现类中注册拦截器：

package com.example.myproject.config;

import com.example.myproject.interceptor.LogoutInterceptor;
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 WebMvcConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LogoutInterceptor());
    }
}

通过以上步骤，我们使用 ThreadLocal 优化了获取用户详细信息的功能。这样可以减少对数据源的重复查询，提高系统性能，尤其在高并发场景下优势更为明显。同时，注意合理管理 ThreadLocal 的生命周期，确保内存使用的安全性和有效性，避免出现内存泄漏等问题。在实际应用中，还可以根据具体需求进一步优化和扩展该功能，如在多线程环境下进行更严格的线程安全测试，或者根据业务逻辑对用户信息的缓存策略进行调整。