Spring Controller中全局变量引起的线程安全问题

在Spring中，注解@Controller去修饰一个类时，默认这个类是单例。但是WEB容器为了性能，必然是多线程的去处理HTTP请求，多线程的HTTP请求经过WEB容器转化为servlet请求，接着由Spring的DispatcherServlet分发到对应的Controller处理类。所以在单例的Controller类中，如果存在全局变量，必然会存在线程安全问题。

下面将示范多种常用写法，有些不会引起线程安全，有些会引起线程安全。

示例1：

这种写法不会引起线程安全，因为 HttpServletRequest 与 HttpServletResponse 申明为形参，形参是局部变量，而局部变量存储在栈中，每个线程又有独立的栈空间，故不会引起线程安全问题。

@Controller
public class TestController {
    
    @RequestMapping(value = "/test1")
    public void thread1(HttpServletRequest request, HttpServletResponse response) throws Exception{
        
        System.out.println("客户端：" + request.getHeader("Thread"));
    }
}

接下来启动10个线程去访问这个接口，在http请求的头部设置线程的名字，模拟10个不同http客户端请求。

public class HttpThread {
    
    public static void main(String[] args) {
        
        for (int i = 0; i < 10; i++) {
            new Thread(new Runnable(){
                public void run(){
                    CloseableHttpClient httpclient = HttpClients.createDefault();
                    HttpGet httpGet = new HttpGet("http://localhost:8080/test1");
                    System.out.println(Thread.currentThread().getName());
                    httpGet.setHeader("Thread", Thread.currentThread().getName());
                    try {
                        httpclient.execute(httpGet);
                    } catch (ClientProtocolException e) {
                        // TODO Auto-generated catch block
                        e.printStackTrace();
                    } catch (IOException e) {
                        // TODO Auto-generated catch block
                        e.printStackTrace();
                    }
                }
            }).start();
        }
    }
}

输出如下：
可以看到10个客户端都已经正常访问，没有线程安全问题。

image.png

示例2：
下面这种写法会引起线程安全问题。有时候一个Controller类中会有多个方法，为了代码的简洁，不想在多个方法中都要写HttpServletRequest request, HttpServletResponse response。把HttpServletRequest，HttpServletResponse 申明为全局变量 ，用@ModelAttribute注解修饰一个方法，并在这个方法中初始化request和response。就可在多处引用。但是这种写法会引起线程安全问题。

@Controller
public class TestController {
    
    public HttpServletRequest request;
    
    public HttpServletResponse response;
    
    /**
     * ModelAttribute 注解代表只要调用TestController类的方法，就一定会先执行该方法，
     * 此处在方法内初始化了Servlet对象。
     * @param request
     * @param response
     */
    @ModelAttribute  
    public void setReqAndRes(HttpServletRequest request, HttpServletResponse response){  
        this.request = request;  
        this.response = response;  
    } 
    
    @RequestMapping(value = "/test1")
     public void thread1() throws Exception{
        
     System.out.println("客户端：" + request.getHeader("Thread"));
     }
}

起30个线程去访问接口：

public class HttpThread {
    
    public static void main(String[] args) {
        
        for (int i = 0; i < 30; i++) {
            new Thread(new Runnable(){
                public void run(){
                    CloseableHttpClient httpclient = HttpClients.createDefault();
                    HttpGet httpGet = new HttpGet("http://localhost:8080/test1");
                    System.out.println(Thread.currentThread().getName());
                    httpGet.setHeader("Thread", Thread.currentThread().getName());
                    try {
                        httpclient.execute(httpGet);
                    } catch (ClientProtocolException e) {
                        // TODO Auto-generated catch block
                        e.printStackTrace();
                    } catch (IOException e) {
                        // TODO Auto-generated catch block
                        e.printStackTrace();
                    }
                }
            }).start();
        }
    }
}

结果如下：
可以看到客户端13出现了多次，而客户端4没有出现。此时如果这个接口里面有response

response.getWriter().write(str);

那么，客户端4将接受不到返回，并且客户端13接收到的结果也有可能是错误的。

image.png

解释一下为什么会出现线程不安全的问题：

image.png

示例3：
使用@Autowired注解可以解决示例2的问题。代码如下：

@Controller
public class TestController {
    
    @Autowired
    public HttpServletRequest request;
    
    @Autowired
    public HttpServletResponse response;
    
    @RequestMapping(value = "/test1")
    public void thread1() throws Exception{
        
        System.out.println("客户端：" + request.getHeader("Thread"));
    }
}

经过多次实验，示例3的写法不会产生Servlet线程安全问题。大家也可以试一试。

image.png

后记：
具体@Autowired注入为什么可以解决线程安全问题，这个估计要看源码才能知道。如果有高人知晓，请多多指教。