淺嘗Spring註解開發_Servlet3.0與SpringMVC

蔚然丶丶發表於2022-05-09

淺嘗Spring註解開發_Servlet 3.0 與 SpringMVC

淺嘗Spring註解開發,基於Spring 4.3.12
Servlet3.0新增了註解支援、非同步處理,可以省去web.xml檔案,非同步處理更高效。

淺嘗Spring註解開發_自定義註冊元件、屬性賦值、自動裝配
淺嘗Spring註解開發_Bean生命週期及執行過程
淺嘗Spring註解開發_AOP原理及完整過程分析(原始碼)
淺嘗Spring註解開發_宣告式事務及原理
淺嘗Spring註解開發_簡單理解BeanFactoryPostProcessor、BeanDefinitionRegistryPostProcessor、ApplicationListener
Spring註解開發_Spring容器建立概述
淺嘗Spring註解開發_Servlet3.0與SpringMVC

Servlet 測試

建立Web動態工程,Servlet3.0需要Tomcat7.0及以上

註解包括@WebServlet()、@WebListener、@WebFilter

  • 傳送請求

    <%@ page language="java" contentType="text/html; charset=UTF-8"
        pageEncoding="UTF-8"%>
    <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    <html>
    <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <title>Insert title here</title>
    </head>
    <body>
    	<a href="hello">hello</a>
    </body>
    </html>
    
  • 處理請求,利用@WebServlet()註解標註

    @WebServlet("/hello")
    public class HelloServlet extends HttpServlet {
    	
    	@Override
    	protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
    		// TODO Auto-generated method stub
    		//super.doGet(req, resp);
    		resp.getWriter().write("hello...");
    	}
    }
    

⭐Servlet容器初始化ServletContainerInitializer

Shared libraries(共享庫) / runtimes pluggability(執行時外掛能力)

容器在啟動應用的時候,會掃描當前應用每一個jar包裡面META-INF/services/javax.servlet.ServletContainerInitializer指定的實現類,啟動並執行這個實現類的方法,並傳入感興趣的型別

原理

  1. Servlet容器啟動會掃描,當前應用裡面每一個jar包的ServletContainerInitializer的實現
  2. 提供ServletContainerInitializer的實現類
    1. 必須繫結在,META-INF/services/javax.servlet.ServletContainerInitializer檔案中
    2. 檔案的內容就是ServletContainerInitializer實現類的全類名

應用

  1. 建立一個實現ServletContainerInitializer的類

    public class MyServletContainerInitializer implements ServletContainerInitializer {
    
    	@Override
    	public void onStartup(Set<Class<?>> arg0, ServletContext sc) throws ServletException {
    		// TODO Auto-generated method stub
    		
    	}
    
    }
    
  2. 在src目錄(或idea在resources目錄下)建立META-INF/services/目錄和javax.servlet.ServletContainerInitializer檔案,內容為實現類全類名

    com.atguigu.servlet.MyServletContainerInitializer
    
  3. 實現介面方法,兩個引數,一個註解

    1. @HandlesTypes:指定感興趣的類
    2. ServletContext:當前web的ServletContext
    3. Set<Class<?>>:感興趣的類的子類集合
    //容器啟動的時候會將@HandlesTypes指定的這個型別下面的子類(實現類,子介面等)傳遞過來;
    //傳入感興趣的型別;
    @HandlesTypes(value={HelloService.class})
    public class MyServletContainerInitializer implements ServletContainerInitializer {
    
    	/**
    	 * 應用啟動的時候,會執行onStartup方法;
    	 * 
    	 * Set<Class<?>> arg0:感興趣的型別的所有子型別;
    	 * ServletContext arg1:代表當前Web應用的ServletContext;一個Web應用一個ServletContext;
    	 * 
    	 */
    	@Override
    	public void onStartup(Set<Class<?>> arg0, ServletContext sc) throws ServletException {
    		// TODO Auto-generated method stub
    		System.out.println("感興趣的型別:");
    		for (Class<?> claz : arg0) {
    			System.out.println(claz);
    		}
    		
    	}
    
    }
    
  4. @HandlesTypes的值是感興趣的類,引數Set<Class<?>> arg0的值是感興趣的類的子類、子介面、實現類等

    • 建立介面HelloService,並建立多個繼承或實現此介面的子類
  5. 應用啟動就會獲得指定的型別

ServletContext註冊Web三大元件

編碼方式註冊Servlet、Filter、Listener

  1. 使用ServletContext註冊Web元件(Servlet、Filter、Listener)
  2. 使用編碼的方式,在專案啟動的時候給ServletContext裡面新增元件
  3. 必須在專案啟動的時候來新增
    1. ServletContainerInitializer得到的ServletContext
    2. ServletContextListener監聽時得到的ServletContext

應用

  1. 自定義Servlet,繼承HttpServlet

    public class UserServlet extends HttpServlet {
    	
    	@Override
    	protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
    		// TODO Auto-generated method stub
    		resp.getWriter().write("tomcat...");
    	}
    
    }
    
  2. 自定義Filter,實現Filter

    public class UserFilter implements Filter {
    
    	@Override
    	public void destroy() {
    		// TODO Auto-generated method stub
    		
    	}
    
    	@Override
    	public void doFilter(ServletRequest arg0, ServletResponse arg1, FilterChain arg2)
    			throws IOException, ServletException {
    		// 過濾請求
    		System.out.println("UserFilter...doFilter...");
    		//放行
    		arg2.doFilter(arg0, arg1);
    		
    	}
    
    	@Override
    	public void init(FilterConfig arg0) throws ServletException {
    		// TODO Auto-generated method stub
    		
    	}
    
    }
    
  3. 自定義Listener,實現ServletContextListener

    /**
     * 監聽專案的啟動和停止
     */
    public class UserListener implements ServletContextListener {
    
    	
    	//監聽ServletContext銷燬
    	@Override
    	public void contextDestroyed(ServletContextEvent arg0) {
    		// TODO Auto-generated method stub
    		System.out.println("UserListener...contextDestroyed...");
    	}
    
    	//監聽ServletContext啟動初始化
    	@Override
    	public void contextInitialized(ServletContextEvent arg0) {
    		// TODO Auto-generated method stub
            
    		//在這裡專案啟動前也可以得到的ServletContext
    		ServletContext servletContext = arg0.getServletContext();
    		System.out.println("UserListener...contextInitialized...");
    	}
    
    }
    
    
  4. 註冊

    • ServletContainerInitializer的一個引數是ServletContext
    • 另外在上面Listener監聽時也能得到ServletContext
    //容器啟動的時候會將@HandlesTypes指定的這個型別下面的子類(實現類,子介面等)傳遞過來;
    //傳入感興趣的型別;
    @HandlesTypes(value={HelloService.class})
    public class MyServletContainerInitializer implements ServletContainerInitializer {
    
    	/**
    	 * 應用啟動的時候,會執行onStartup方法;
    	 * 
    	 * Set<Class<?>> arg0:感興趣的型別的所有子型別;
    	 * ServletContext arg1:代表當前Web應用的ServletContext;一個Web應用一個ServletContext;
    	 * 
    	 * 1)、使用ServletContext註冊Web元件(Servlet、Filter、Listener)
    	 * 2)、使用編碼的方式,在專案啟動的時候給ServletContext裡面新增元件;
    	 * 		必須在專案啟動的時候來新增;
    	 * 		1)、ServletContainerInitializer得到的ServletContext;
    	 * 		2)、ServletContextListener得到的ServletContext;
    	 */
    	@Override
    	public void onStartup(Set<Class<?>> arg0, ServletContext sc) throws ServletException {
    		// TODO Auto-generated method stub
    		System.out.println("感興趣的型別:");
    		for (Class<?> claz : arg0) {
    			System.out.println(claz);
    		}
    		
    		//註冊元件  ServletRegistration  
    		ServletRegistration.Dynamic servlet = sc.addServlet("userServlet", new UserServlet());
    		//配置servlet的對映資訊
    		servlet.addMapping("/user");
    		
    		
    		//註冊Listener
    		sc.addListener(UserListener.class);
    		
    		//註冊Filter  FilterRegistration
    		FilterRegistration.Dynamic filter = sc.addFilter("userFilter", UserFilter.class);
    		//配置Filter的對映資訊,另一個方法引數是直接使用Servlet攔截
    		filter.addMappingForUrlPatterns(EnumSet.of(DispatcherType.REQUEST), true, "/*");
    		
    	}
    
    }
    

Servlet與SpringMVC整合

原理分析

web容器啟動,掃描指定位置類名,發現感興趣的類,然後從這個類的子類中選擇建立元件物件

  1. 匯入jar包

            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-webmvc</artifactId>
                <version>4.3.11.RELEASE</version>
            </dependency>
            <dependency>
                <groupId>javax.servlet</groupId>
                <artifactId>javax.servlet-api</artifactId>
                <version>3.0.1</version>
                <scope>provided</scope>
            </dependency>
    
  2. web容器在啟動的時候,會掃描每個jar包下的META-INF/services/javax.servlet.ServletContainerInitializer,開啟spring-web.jar目錄下的檔案

    org.springframework.web.SpringServletContainerInitializer
    
  3. 載入這個檔案指定的類SpringServletContainerInitializer,發現@HandlesTypes註解中感興趣的類是WebApplicationInitializer

  4. Spring的應用一啟動會載入感興趣的WebApplicationInitializer介面的下的所有元件,並且為WebApplicationInitializer元件建立物件(元件不是介面,不是抽象類)

    @HandlesTypes(WebApplicationInitializer.class)
    public class SpringServletContainerInitializer implements ServletContainerInitializer {
    	@Override
    	public void onStartup(Set<Class<?>> webAppInitializerClasses, ServletContext servletContext)
    			throws ServletException {
    				//...
    				//防禦:一些 servlet 容器為我們提供了無效的類,不管@HandlesTypes 說什麼......
    				if (!waiClass.isInterface() && !Modifier.isAbstract(waiClass.getModifiers()) &&
    						WebApplicationInitializer.class.isAssignableFrom(waiClass)) {
    						initializers.add((WebApplicationInitializer) waiClass.newInstance());
    				}
    				//...
    }
    
  5. 關於感興趣的類WebApplicationInitializer的子類(子介面、抽象)三個抽象類:

    1. AbstractContextLoaderInitializer:建立根容器;createRootApplicationContext()
    2. AbstractDispatcherServletInitializer:
      1. 建立一個web的ioc容器:createServletApplicationContext()
      2. 建立了DispatcherServlet:createDispatcherServlet()
      3. 將建立的DispatcherServlet新增到ServletContext中:servletContext.addServlet(servletName, dispatcherServlet)
      4. 保留一個抽象方法待實現,返回將註冊 DispatcherServlet 的名稱:getServletMappings()
    3. AbstractAnnotationConfigDispatcherServletInitializer:註解方式配置的DispatcherServlet初始化器
      1. 建立根容器:createRootApplicationContext()
      2. 保留一個抽象方法待實現,傳入一個配置類:getRootConfigClasses()
      3. 建立web的ioc容器: createServletApplicationContext()
      4. 保留一個抽象方法待實現,獲取配置類:getServletConfigClasses()
  6. 總結:以註解方式來啟動SpringMVC,可以選擇其中一個抽象類,例如繼承AbstractAnnotationConfigDispatcherServletInitializer,實現抽象方法指定DispatcherServlet的配置資訊

整合

SpringMVC官方文件Web on Servlet Stack (spring.io)

Spring關於DispatcherServlet的解釋,將DispatcherServlet分為具有上下繼承關係的兩部分,其中可在多個例項之間共享的Root WebApplicationContext包含中間服務層Service、資料來源Repositories,和可在特定於Servlet的子項被覆蓋的控制器Controllers、檢視解析器ViewResolver、處理器對映器HandlerMapping其他與web相關的bean)

  講過上節分析,選擇感興趣的類WebApplicationInitializer的其中一個子介面AbstractAnnotationConfigDispatcherServletInitializer來實現

  1. 實現AbstractAnnotationConfigDispatcherServletInitializer介面並配置

    //web容器啟動的時候建立物件;呼叫方法來初始化容器以前前端控制器
    public class MyWebAppInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {
    
    	//獲取根容器的配置類;(Spring的配置檔案)   父容器;
    	@Override
    	protected Class<?>[] getRootConfigClasses() {
    		// TODO Auto-generated method stub
    		return new Class<?>[]{RootConfig.class};
    	}
    
    	//獲取web容器的配置類(SpringMVC配置檔案)  子容器;
    	@Override
    	protected Class<?>[] getServletConfigClasses() {
    		// TODO Auto-generated method stub
    		return new Class<?>[]{AppConfig.class};
    	}
    
    	//獲取DispatcherServlet的對映資訊
    	//  /:攔截所有請求(包括靜態資源(xx.js,xx.png)),但是不包括*.jsp;
    	//  /*:攔截所有請求;連*.jsp頁面都攔截;jsp頁面是tomcat的jsp引擎解析的;
    	@Override
    	protected String[] getServletMappings() {
    		// TODO Auto-generated method stub
    		return new String[]{"/"};
    	}
    
    }
    
  2. 建立兩個配置

    1. Spring的配置檔案,根容器

      //Spring的容器不掃描controller;父容器
      @ComponentScan(value="com.atguigu",excludeFilters={
      		@Filter(type=FilterType.ANNOTATION,classes={Controller.class})
      })
      public class RootConfig {
      
      }
      
    2. SpringMVC配置檔案,web容器

      //SpringMVC只掃描Controller;子容器
      //useDefaultFilters=false 禁用預設的過濾規則;
      @ComponentScan(value="com.atguigu",includeFilters={
      		@Filter(type=FilterType.ANNOTATION,classes={Controller.class})
      },useDefaultFilters=false)
      public class AppConfig  extends WebMvcConfigurerAdapter  {
      
      }
      
  3. 建立業務

    1. Service

      @Service
      public class HelloService implements ApplicationContextAware {
      
      	public String sayHello(String name){
      
      		return "Hello "+name;
      	}
      
      }
      
    2. Controller

      @Controller
      public class HelloController {
      	
      	@Autowired
      	HelloService helloService;
      	
      	@ResponseBody
      	@RequestMapping("/hello")
      	public String hello(){
      		String hello = helloService.sayHello("tomcat..");
      		return hello;
      	}
      }
      

定製SpringMVC

與之前使用xml檔案相似,可以配置檢視解析器、靜態資源訪問、攔截器

可參考Spring文件Web on Servlet Stack (spring.io)

  1. @EnableWebMvc:開啟SpringMVC定製配置功能,與xml中的<mvc:annotation-driven>相同

  2. 配置元件,實現WebMvcConfigurer(Spring4中用WebMvcConfigurerAdapter)

    //SpringMVC只掃描Controller;子容器
    //useDefaultFilters=false 禁用預設的過濾規則;
    @ComponentScan(value="com.atguigu",includeFilters={
    		@Filter(type=FilterType.ANNOTATION,classes={Controller.class})
    },useDefaultFilters=false)
    @EnableWebMvc
    public class AppConfig  extends WebMvcConfigurerAdapter  {
    
    	//定製
    	
    	//檢視解析器
    	@Override
    	public void configureViewResolvers(ViewResolverRegistry registry) {
    		// TODO Auto-generated method stub
    		//預設所有的頁面都從 /WEB-INF/ xxx .jsp
    		//registry.jsp();
    		registry.jsp("/WEB-INF/views/", ".jsp");
    	}
    	
    	//靜態資源訪問
    	@Override
    	public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
    		// TODO Auto-generated method stub
    		configurer.enable();
    	}
    	
    	//攔截器
    	@Override
    	public void addInterceptors(InterceptorRegistry registry) {
    		// TODO Auto-generated method stub
    		//super.addInterceptors(registry);
    		registry.addInterceptor(new MyFirstInterceptor()).addPathPatterns("/**");
    	}
    
    }
    

    攔截器

    public class MyFirstInterceptor implements HandlerInterceptor {
    
    	//目標方法執行之前執行
    	@Override
    	public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
    			throws Exception {
    		// TODO Auto-generated method stub
    		System.out.println("preHandle..."+request.getRequestURI());
    		return true;
    	}
    
    	//目標方法執行正確以後執行
    	@Override
    	public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
    			ModelAndView modelAndView) throws Exception {
    		// TODO Auto-generated method stub
    		System.out.println("postHandle...");
    
    	}
    
    	//頁面響應以後執行
    	@Override
    	public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
    			throws Exception {
    		// TODO Auto-generated method stub
    		System.out.println("afterCompletion...");
    	}
    
    }
    

⭐Servlet3.0 非同步請求

  在Servlet3.0之前,Servlet才採用Thread—Per—Request的方式處理請求。即每一次http請求都由一個執行緒從頭到尾負責處理。

  如果一個請求需要進行IO操作,比如訪問資料庫,呼叫第三方服務介面等,那麼其所對應的執行緒將同步地等待IO操作完成,而IO操作是非常慢的,所以此時的執行緒並不能及時的釋放回執行緒池以供後續使用,在併發量越來越大的情況下,這將帶來嚴重的新能問題。即便像Spring、struts這樣的高層框架也脫離不了這樣的問題,因為他們都是建立在Servlet之上的。為了解決這樣的問題,Servlet3.0引入了一步處理,然後在Servlet3.1中又引入了非阻塞IO來進行增加一步處理的效能。

同步請求

每次請求時從執行緒池獲取一個執行緒,然後處理請求,直到處理完成,仍由這個執行緒響應。如果一個執行緒等待時間過長,其他請求就會佔滿執行緒池

image

驗證

  1. 傳送一個請求,獲取處理請求前後的執行緒

    @WebServlet("/hello")
    public class HelloServlet extends HttpServlet {
    	
    	@Override
    	protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
    		// TODO Auto-generated method stub
    		//super.doGet(req, resp);
    		System.out.println(Thread.currentThread()+" start...");
    		try {
    			sayHello();
    		} catch (Exception e) {
    			e.printStackTrace();
    		}
    		resp.getWriter().write("hello...");
    		System.out.println(Thread.currentThread()+" end...");
    	}
    	
    	public void sayHello() throws Exception{
    		System.out.println(Thread.currentThread()+" processing...");
    		Thread.sleep(3000);
    	}
    
    }
    
  2. 輸出

    • 整個請求都是由一個執行緒處理
    Thread[http-nio-8888-exec-10,5,main] start...
    Thread[http-nio-8888-exec-10,5,main] processing...
    Thread[http-nio-8888-exec-10,5,main] end...
    

非同步請求

當請求過來時,由主執行緒池中一條執行緒處理,當開始非同步處理時,主執行緒就結束返回,等待其他請求,非同步處理執行緒的一條執行緒同時開始處理請求。

image

驗證

  1. 非同步物件AsyncContext可以開始和完成非同步處理,同時開啟註解@WebServlet(value="/xxx",asyncSupported=true)

    @WebServlet(value="/async",asyncSupported=true)
    public class HelloAsyncServlet extends HttpServlet {
    	
    	@Override
    	protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
    		//1、支援非同步處理asyncSupported=true
    		//2、開啟非同步模式
    		//主執行緒開始
    		System.out.println("main thread start..."+Thread.currentThread()+"==>"+System.currentTimeMillis());
    		AsyncContext startAsync = req.startAsync();
    		
    		//3、業務邏輯進行非同步處理;開始非同步處理
    		startAsync.start(new Runnable() {
    			@Override
    			public void run() {
    				try {
    					//副執行緒開始
    					System.out.println("vice thread start..."+Thread.currentThread()+"==>"+System.currentTimeMillis());
    					sayHello();
    					startAsync.complete();
    					//獲取到非同步上下文
    					//AsyncContext asyncContext = req.getAsyncContext();
    					//4、獲取響應
    					//使用asyncContext.getResponse()副執行緒不能結束,仍使用startAsync.getResponse()獲取響應
    					//ServletResponse response = asyncContext.getResponse();
    					ServletResponse response = startAsync.getResponse();
    					response.getWriter().write("hello async...");
    					//副執行緒結束
    					System.out.println("vice thread end..."+Thread.currentThread()+"==>"+System.currentTimeMillis());
    				} catch (Exception e) {
    				}
    			}
    		});		
    		//主執行緒結束
    		System.out.println("main thread end..."+Thread.currentThread()+"==>"+System.currentTimeMillis());
    	}
        
    	//處理過程
    	public void sayHello() throws Exception{
    		System.out.println(Thread.currentThread()+" processing...");
    		Thread.sleep(3000);
    	}
    }
    
  2. 輸出

    • 主執行緒開啟後遇到非同步處理立刻結束
    • 主執行緒結束同時副執行緒開始處理非同步請求
    //主執行緒
    main thread start...Thread[http-nio-8888-exec-5,5,main]==>1651997065639
    main thread end...Thread[http-nio-8888-exec-5,5,main]==>1651997065648
    //副執行緒
    vice thread start...Thread[http-nio-8888-exec-7,5,main]==>1651997065648
    Thread[http-nio-8888-exec-7,5,main] processing...
    vice thread end...Thread[http-nio-8888-exec-7,5,main]==>1651997068656
    

⭐SpringMVC非同步處理

參考SpringMVC官方文件Web on Servlet Stack (spring.io)

返回Callable

Controller返回Callable型別的返回值,非同步處理在Callable類中進行

過程

Callable處理過程

  1. 控制器返回Callable
  2. SpringMVC非同步處理,將Callable 提交到 TaskExecutor 使用一個隔離的執行緒進行執行
  3. DispatcherServlet和所有的Filter退出web容器的執行緒,但是response 保持開啟狀態
  4. Callable返回結果,SpringMVC將請求重新派發給容器,恢復之前的處理
  5. 根據Callable返回的結果。SpringMVC繼續進行檢視渲染流程等(從收請求-檢視渲染)
  6. 對於非同步處理,普通攔截器不能攔截非同步中的程式碼,使用非同步攔截器
    1. 原生API的AsyncListener
    2. SpringMVC:實現AsyncHandlerInterceptor

應用

  1. 非同步處理

    @Controller
    public class AsyncController {
        
    	@ResponseBody
    	@RequestMapping("/async01")
    	public Callable<String> async01(){
    		//主執行緒開始
    		System.out.println("main thread start..."+Thread.currentThread()+"==>"+System.currentTimeMillis());
    
    		Callable<String> callable = new Callable<String>() {
    			@Override
    			public String call() throws Exception {
    				//副執行緒開始
    				System.out.println("vice thread start..."+Thread.currentThread()+"==>"+System.currentTimeMillis());
    
    				//處理業務
    				Thread.sleep(2000);
    				//副執行緒開始
    				System.out.println("vice thread end..."+Thread.currentThread()+"==>"+System.currentTimeMillis());
    
    				return "Callable<String> async01()";
    			}
    		};
    		
    		//主執行緒結束
    		System.out.println("main thread end..."+Thread.currentThread()+"==>"+System.currentTimeMillis());
    
    		return callable;
    	}
    }
    
  2. 輸出

    • 主執行緒和副執行緒不是同一執行緒
    • 攔截器攔截了兩次同一個請求
    • 上面兩處都是Callable的原因,Callable會另起一個執行緒,並且結束前端控制器,等非同步處理完在恢復前端控制器繼續執行,所以有兩次攔截器,並且要使用非同步攔截器
    //攔截器
    preHandle.../springmvc_annotation_war/async01
    
    //主執行緒,執行完DispatcherServlet及所有的Filter退出執行緒
    main thread start...Thread[http-nio-8888-exec-10,5,main]==>1652003199856
    main thread end...Thread[http-nio-8888-exec-10,5,main]==>1652003199860
    
    //副執行緒,等待Callable執行
    vice thread start...Thread[MvcAsync1,5,main]==>1652003199873
    vice thread end...Thread[MvcAsync1,5,main]==>1652003201875
    
    //攔截器,再次收到之前重發過來的請求
    preHandle.../springmvc_annotation_war/async01
    postHandle...
    afterCompletion...
    

DeferredResult

上面的Callable使用與簡單場景,可以處理當前簡單業務,對於多應用複雜業務可以使用DeferredResult型別,在當前應用處理請求,然後繼續向下執行,當其他應用完成請求之後,通知DeferredResult就可以響應結果結束請求。對應下圖:

應用1是當前應用,負責接受請求,中間隔著其他元件,應用2負責非同步處理請求,然後將結果返回給當前應用1。

image

官方文件

  在 Servlet 容器中啟用非同步請求處理功能後,控制器方法可以使用 DeferredResult 包裝任何支援的控制器方法返回值,如以下示例所示:

@GetMapping("/quotes")
@ResponseBody
public DeferredResult<String> quotes() {
    DeferredResult<String> deferredResult = new DeferredResult<String>();
    // Save the deferredResult somewhere..
    // 將deferredResult儲存到某個地方。
    return deferredResult;
}

// From some other thread...
// 從其他執行緒...
deferredResult.setResult(result);

  控制器可以從不同的執行緒非同步生成返回值 — 例如,響應外部事件(JMS 訊息)、計劃任務或其他事件。

應用

  1. 請求

    • 在當前應用接收請求,然後將DeferredResult儲存起來
    • 然後返回
    @Controller
    public class AsyncController {
    	
    	
    	@ResponseBody
    	@RequestMapping("/createOrder")
    	public DeferredResult<Object> createOrder(){
    		//使用超時值和要使用的預設結果建立DeferredResult
    		DeferredResult<Object> deferredResult = new DeferredResult<>((long)3000, "create fail...");
    			
    		DeferredResultQueue.save(deferredResult);
    		
    		return deferredResult;
    	}
    }
    
  2. 儲存DeferredResult佇列

    • 有存取功能
    public class DeferredResultQueue {
    	
    	private static Queue<DeferredResult<Object>> queue = new ConcurrentLinkedQueue<DeferredResult<Object>>();
    	
    	public static void save(DeferredResult<Object> deferredResult){
    		queue.add(deferredResult);
    	}
    	
    	public static DeferredResult<Object> get( ){
    		return queue.poll();
    	}
    
    }
    
  3. 模擬另一個應用,非同步處理業務

    • 真實請情況可以是另一個應用或執行緒
    	@ResponseBody
    	@RequestMapping("/create")
    	public String create(){
    		//建立訂單
    		String order = UUID.randomUUID().toString();
            //取出DeferredResult
    		DeferredResult<Object> deferredResult = DeferredResultQueue.get();
            //放入結果,同時應用1完成非同步處理
    		deferredResult.setResult(order);
    		return "success===>"+order;
    	}
    
  4. 結果

    成功
    52917142-3a12-4df5-9c89-258cbf0d0c3a
    success===>52917142-3a12-4df5-9c89-258cbf0d0c3a
    失敗
    create fail...
    
  5. DeferredResult部分文件

    DeferredResult 提供了使用 Callable 進行非同步請求處理的替代方法。 雖然代表應用程式同時執行 Callable,但使用 DeferredResult 應用程式可以從其選擇的執行緒中生成結果。
    子類可以擴充套件此類以輕鬆地將附加資料或行為與 DeferredResult 關聯。 例如,可能希望通過擴充套件類併為使用者新增一個附加屬性來關聯用於建立 DeferredResult 的使用者。 這樣,以後可以很容易地訪問使用者,而無需使用資料結構來進行對映。
    
    將附加行為與此類關聯的示例可以通過擴充套件類以實現附加介面來實現。 例如,您可能希望實現 Comparable 以便在將 DeferredResult 新增到 PriorityQueue 時以正確的順序對其進行處理。
    
    onCompletion
    public void onCompletion(Runnable callback)
    註冊程式碼在非同步請求完成時呼叫。
    當非同步請求因任何原因(包括超時和網路錯誤)完成時,從容器執行緒呼叫此方法。
    這對於檢測延遲例項不再可用很有用。
    
    public boolean setResult(T result)
    設定DeferredResult的值並處理它。
    

更詳細的文章推薦:

DeferredResult的使用場景及用法 - 胡桃同學的個人空間 - OSCHINA - 中文開源技術交流社群

相關文章