Servlet3.0实现注解开发

DataPulse-辉常努腻

于 2021-06-24 16:54:22 发布

阅读量670

点赞数 1

文章标签： java 新星计划

本文链接：https://blog.csdn.net/qq_43900956/article/details/118191930

版权

Servlet3.0中实现注解开发

Servlet3.0好处：
支持注解配置。可以不需要web.xml了。

* 步骤：
    1. 创建JavaEE项目，选择Servlet的版本3.0以上，可以不创建web.xml
    2. 定义一个类，实现Servlet接口
    3. 复写方法
    4. 在类上使用@WebServlet注解，进行配置

urlpartten：Servlet虚拟访问路径

然而通过观察@WebServlet注解发现，它的urlPatterns定义的是一个String类型的数组，也就是说可以给一个Servlet定义多个虚拟路径
6.Servlet3.0中实现注解开发

在配置的@WebServlet的时候有时候是不设置参数参数名，直接传入路径，有时候又设置为urlPatterns，而默认不传入参数名，的时候其实，值是赋值给value的而不是urlPatterns

就感到很困惑到底value和urlPatterns有什么区别？查到了属性功能的列表并记录一下

webServlet注解的类型和描述

属性名	类型	描述
name	String	servlet-name，如果没有显示指定，该Servlet的取值为全限定名
value	String[]	等价于 urlPatterns 属性，与该属性不能同时使用
urlPatterns	String[]	指定Servlet url的匹配模式，等价于
loadOnStartup	int	指定Servlet的加载顺序
initParams	webInitParam[]	指定初始化参数
asyncSupported	boolean	是否支持异步操作
description	String	描述
displayName	String	servlet显示名

servlet3.0种的常用的注解

@WebServlet：
- 该注解用来配置Servlet，其将会在服务器启动时被tomcat容器处理，容器将根据具体的属性配置将相应的类部署为 Servlet
@WebListener
- 表示的就是我们之前的在xml中配置的
```
<listener>
<listener-class>ListenerClass</listener-class>
</listener>
```
  我们只需要在我们写好的Listener类上面加上这个@WebListener注解就OK啦
@WebFilter
- 这个注解就是表示的过滤器同样的也是直接注解在写好的Filter上面就ok了

servlet3.0中的异步操作

导读模块：

servlet3.x之后开始支持异步操作
但是这块的异步与ajax的异步是不一样的
因为这个是servlet代码的异步发邮件是一个耗时的操作
我们就用servlet3.0来模拟一个异步操作

例子中的代码

index.jsp

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Insert title here</title>
</head>
<body>
	<a href="<%=request.getContextPath()%>/manage/manager.do?">发邮件</a>
</body>
</html>

list.jsp

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Insert title here</title>
</head>
<body>
   邮件发送中请耐心等待.....
   <br>
   <a href="<%=request.getContextPath() %>/jsps/show.jsp">查看邮件发送的状态</a>
</body>
</html>

show.jsp

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<%@taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c"%>
<!DOCTYPE html>
<html>
	<head>
		<meta charset="UTF-8">
		<title>Insert title here</title>
	</head>
	<body>
		<c:if test="${empty message}">
			 <c:out value="邮件正在发送"></c:out>
		</c:if>
		<c:if test="${not empty message}">
			 <c:out value="${message}"></c:out>
		</c:if>
	</body>
</html>

ManagerServlet.java

package com.Li.manage.manager;

import java.io.IOException;

import javax.servlet.AsyncContext;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebInitParam;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.catalina.connector.Request;

/**
 * @desc   
 * @author Li Ya Hui 
 * @time   2021年6月23日 下午2:56:53
 */
@SuppressWarnings("all")
@WebServlet(
		value  = "/manage/manager.do",
		initParams = {
				//servlet的初始化参数
				@WebInitParam(name = "userName", value = "root"),
				@WebInitParam(name = "passWord", value = "root")
		},
		//是否支持异步 默认为false
		asyncSupported = true
)
public class ManagerServlet extends HttpServlet {

	
	@Override
	public void init() throws ServletException {
		//通过初始化方法 获得一些通过注解 加载的初始数据 
		
		System.out.println("servlet启动预加载的一些数据："+getServletConfig().getInitParameterNames().nextElement());
		
	}
	
	@Override
	protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
		String method = req.getParameter("method");
		System.out.println("method:"+method);
		
		//获取异步对象
		AsyncContext ac = req.startAsync();
		
		//2.多线程任务类   将线程对象加入定时器
		ThreadTask threadTask = new ThreadTask( ac );
		
		//3.设定一个超时时间
		ac.setTimeout(200);
		
		//4.开启
		ac.start(threadTask);
		
		//5.主线程继续 继续做自己喜欢做的事
		req.getRequestDispatcher("/jsps/list.jsp").forward(req, resp);
		
	}	
}

ThreadTask.java

package com.Li.manage.manager;

import javax.servlet.AsyncContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;

/**
 * @desc   
 * @author Li Ya Hui 
 * @time   2021年6月23日 下午7:40:15
 */
public class ThreadTask implements Runnable {

	AsyncContext ac = null;
	
	public ThreadTask(AsyncContext ac) {
		this.ac = ac ;
	}
	
	@Override
	public void run() {
		try {
			System.out.println("异步处理开始的时间："+System.currentTimeMillis());
			
			//1.通过ac获取request对象
			HttpServletRequest request =(HttpServletRequest) ac.getRequest();
			
			//2.通过request对象获取session对象
			HttpSession session = request.getSession();
			
			//3.模拟一个耗时操作
			Thread.sleep(50000);
			
			//4.将信息存入session中
			session.setAttribute("message",  "邮件已经发送了");
			System.out.println("异步处理结果的时间");
			
		} catch (InterruptedException e) {
			System.out.println("中断异常...");
		}
	}
}

CharacterEncodingFilter.java

package com.Li.Filter;

import java.io.IOException;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.annotation.WebFilter;
import javax.servlet.annotation.WebInitParam;

/**
 * @desc   字符集的
 * @author Li Ya Hui 
 * @time   2021年6月23日 下午5:05:47
 */
//过滤器的注解式开发
//@WebFilter(filterName = "charFilter", urlPatterns = "/manage/*",initParams = {@WebInitParam(name = "sex",value = "boy")})
public class characterEncodingFilter implements Filter {

	@Override
	public void init(FilterConfig filterConfig) throws ServletException {
		System.out.println("过滤器通过初始化预加载的一些数据："+filterConfig.getInitParameter("sex"));
	}

	@Override
	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
			throws IOException, ServletException {
		System.out.println("字符集起作用了......");
	}

	@Override
	public void destroy() {
	}
}

MyContextListener.java

package com.Li.listener;

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;

/**
 * @desc   上下文监听器
 * @author Li Ya Hui 
 * @time   2021年6月23日 下午4:48:43
 */
//WebListener监听器的注解式配置
@WebListener
public class MyContextListener implements ServletContextListener{

	@Override
	public void contextInitialized(ServletContextEvent sce) {
		System.out.println("tomcat启动...");
	}

	@Override
	public void contextDestroyed(ServletContextEvent sce) {
		System.out.println("tomcat销毁..");
		
	}

}

AsyncContext异步处理http请求

AsyncContext的startAsync()方法开启异步

Servlet 3.0的异步处理支持特性，使Servlet 线程不再需要一直阻塞，直到业务处理完毕才能再输出响应，最后才结束该 Servlet 线程。在接收到请求之后，Servlet 线程可以将耗时的操作委派给另一个线程来完成，自己在不生成响应的情况下返回至容器。针对业务处理较耗时的情况，这将大大减少服务器资源的占用，并且提高并发处理速度。

1、传统Servlet处理

Web容器会为每个请求分配一个线程，默认情况下，响应完成前，该线程占用的资源都不会被释放。若有些请求需要长时间(例如长处理时间运算、等待某个资源)，就会长时间占用线程所需资源，若这类请求很多，许多线程资源都被长时间占用，会对系统的性能造成负担。

2、新特性：异步处理

Servlet 3.0新增了异步处理，可以先释放容器分配给请求的线程与相关资源，减轻系统负担，原先释放了容器所分配线程的请求，其响应将被延后，可以在处理完成(例如长时间运算完成、所需资源已获得)时再对客户端进行响应。

Servlet 3.0 之前，一个普通 Servlet 的主要工作流程大致如下：

第一步，Servlet 接收到请求之后，可能需要对请求携带的数据进行一些预处理；
第二步，调用业务接口的某些方法，以完成业务处理；
第三步，根据处理的结果提交响应，Servlet 线程结束。
其中第二步的业务处理通常是最耗时的，这主要体现在数据库操作，以及其它的跨网络调用等，在此过程中，Servlet 线程一直处于阻塞状态，直到业务方法执行完毕。在处理业务的过程中，Servlet 资源一直被占用而得不到释放，对于并发较大的应用，这有可能造成性能的瓶颈。对此，在以前通常是采用私有解决方案来提前结束 Servlet 线程，并及时释放资源。

Servlet 3.0 针对这个问题做了开创性的工作，现在通过使用 Servlet 3.0 的异步处理支持，之前的 Servlet 处理流程可以调整为如下的过程：

第一步，Servlet 接收到请求之后，可能首先需要对请求携带的数据进行一些预处理；
第二步，Servlet 线程将请求转交给一个异步线程来执行业务处理，线程本身返回至容器，
第三步，Servlet 还没有生成响应数据，异步线程处理完业务以后，可以直接生成响应数据（异步线程拥有 ServletRequest 和 ServletResponse 对象的引用），或者将请求继续转发给其它 Servlet。
Servlet 线程不再是一直处于阻塞状态以等待业务逻辑的处理，而是启动异步线程之后可以立即返回。

3、AsyncContext源码

在ServletRequest上提供了startAsync()方法

@Override
public AsyncContext startAsync() {
    return startAsync(getRequest(),response.getResponse());
}

@Override
public AsyncContext startAsync(ServletRequest request,
                               ServletResponse response) {
    if (!isAsyncSupported()) {
        IllegalStateException ise =
            new IllegalStateException(sm.getString("request.asyncNotSupported"));
        log.warn(sm.getString("coyoteRequest.noAsync",
                              StringUtils.join(getNonAsyncClassNames())), ise);
        throw ise;
    }

if (asyncContext == null) {
    asyncContext = new AsyncContextImpl(this);
}

asyncContext.setStarted(getContext(), request, response,
                        request==getRequest() && response==getResponse().getResponse());
asyncContext.setTimeout(getConnector().getAsyncTimeout());

return asyncContext;

}

1.startAsync()会直接利用原有的请求与响应对象来创建AsyncContext

2.startAsync(ServletRequest request,ServletResponse response)可以传入自行创建的请求、响应封装对象；

可以通过AsyncContext的getRequest()、getResponse()方法取得请求、响应对象，此次对客户端的响应将暂缓至调用AsyncContext的complete()或dispatch()方法为止，前者表示响应完成，后者表示将调派指定的URL进行响应。

4、AsyncContext应用场景

例如在Nacos中; 客户端向服务端发起请求获取是否有变更的配置数据,如果没有的话,等待三十秒再返回;(主要是Nacos在这30秒内,这时配置变更了,则立马返回响应变更数据); 那这时候就可以使用AsyncContext这个对象了

String ip = RequestUtil.getRemoteIp(req);

// Must be called by http thread, or send response.
// 一定要由HTTP线程调用，否则离开后容器会立即发送响应
final AsyncContext asyncContext = req.startAsync();

// AsyncContext.setTimeout() is incorrect, Control by oneself
// AsyncContext.setTimeout()的超时时间不准，所以只能自己控制
asyncContext.setTimeout(0L);

//交给线程池异步执行
ConfigExecutor.executeLongPolling(
    new ClientLongPolling(asyncContext, clientMd5Map, ip, probeRequestSize, timeout, appName, tag));

代码中得到AsyncContext实例之后,就会先释放容器分配给请求的线程与相关资源,然后把把实例放入了一个定时任务里面;等时间到了或者有配置变更之后,调用complete()响应完成

void generateResponse(List<String> changedGroups) {
    if (null == changedGroups) {
        // Tell web container to send http response.
        asyncContext.complete();
        return;
  	 }

HttpServletResponse response = (HttpServletResponse) asyncContext.getResponse();

    try {
        final String respString = MD5Util.compareMd5ResultString(changedGroups);

        // Disable cache.
        //禁用缓存
        response.setHeader("Pragma", "no-cache");
        response.setDateHeader("Expires", 0);
        response.setHeader("Cache-Control", "no-cache,no-store");
        response.setStatus(HttpServletResponse.SC_OK);
        response.getWriter().println(respString);
        asyncContext.complete();
    } catch (Exception ex) {
        PULL_LOG.error(ex.toString(), ex);
        asyncContext.complete();
    }
}

DataPulse-辉常努腻

关注

1
点赞
踩
4

收藏

觉得还不错? 一键收藏
打赏
0
评论
Servlet3.0实现注解开发

Servlet3.0中实现注解开发Servlet3.0好处：支持注解配置。可以不需要web.xml了。* 步骤： 1. 创建JavaEE项目，选择Servlet的版本3.0以上，可以不创建web.xml 2. 定义一个类，实现Servlet接口 3. 复写方法 4. 在类上使用@WebServlet注解，进行配置urlpartten：Servlet虚拟访问路径然而通过观察@WebServlet注解发现，它的urlPatterns定义的是一个String类型的
复制链接

扫一扫