springboot注册自定义路由 springboot注册功能

一、前言

在 Spring Boot 中已经移除了 web.xml ，如果需要注册添加 Servlet、Filter、Listener 为 Spring Bean，在 Spring Boot 中有两种方式：

1. 使用 Servlet 3.0 API 的注解 @WebServlet、@WebFilter、@Listener 用来配置。
2. Spring Boot JavaConfig 注解配置 Bean 的方式来进行配置。

 

二、注册之前

在使用 Servlet 时，需要在 Spring Boot 入口类添加 @ServletComponentScan 注解，告诉 Spring Boot 去扫描使用下面注册的 Servlet、Filter、Listener

@SpringBootApplication
@ServletComponentScan
public class SpringBootServletApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringBootServletApplication.class, args);
    }

}

 

三、注册 Servlet

1. @WebServlet 属性

属性类型描述nameString指定Servlet名称，等价于 valueString[]等同于 urlPatterns 属性，两者不应该同时使用urlPatternsString[]指定一组 Servlet 的 URL 匹配模式。等价于标签loadOnStartupint指定 Servlet 的加载顺序，等价于 标签initParamsWebInitParam[]指定一组 Servlet 初始化参数，等价于标签asyncSupportedboolean声明 Servlet 是否支持异步操作模式，等价于 标签smallIconString此 Servlet 的小图标largeIconString此 Servlet 的大图标descriptionString该 Servlet 的描述信息，等价于 标签displayNameString该 Servlet 的显示名，通常配合工具使用，等价于 标签

 

2. 示例

@WebServlet(urlPatterns = "/TestServlet")
public class TestServlet extends HttpServlet {

    /**
     *
     */
    private static final long serialVersionUID = -3325041776508043481L;

    @Override
    public void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
        doPost(req, resp);
    }
/*
* 实现请求uri和header打印，另外返回一个json
*/
    @Override
    public void doPost(HttpServletRequest req, HttpServletResponse resp) throws IOException {
        System.out.println("RequestURI:" + req.getRequestURI());

        System.out.println("Request Headers:");

        StringBuilder sb = new StringBuilder();
        Enumeration<?> names = req.getHeaderNames();
        while (names.hasMoreElements()) {
            String name = names.nextElement().toString();
            Enumeration<?> hs = req.getHeaders(name);
            sb.append(name).append(":");
            while (hs.hasMoreElements()) {
                sb.append(hs.nextElement()).append(";");
            }
        }
        System.out.println(sb);
        
        ObjectMapper om=new ObjectMapper();
        UserEntity user=new UserEntity();
        user.setId(1L);
        user.setUserName("zwqh");
        user.setUserSex("男");
        user.setHeaders(sb.toString());
        String resultJson=om.writeValueAsString(user);

        resp.setContentType("application/json;charset=UTF-8");
        
        resp.getWriter().print(resultJson);
    }

}

其中@WebServlet(urlPatterns = "/TestServlet")等价于以下代码：

<servlet>
	<!-- 类名 -->
	<servlet-name> TestServlet </servlet-name>
	<!-- 所在的包 -->
	<servlet-class> cn.zwqh.springbboot.servlet.TestServlet </servlet-class>
	</servlet>
	<servlet-mapping>
	<servlet-name> TestServlet </servlet-name>
	<!-- 访问的url路径地址 -->
	<url-pattern> /TestServlet </url-pattern>
</servlet-mapping>

 

3. 测试

浏览器访问 http://127.0.0.1:8080/TestServlet

 

日志输出：

 

 

四、注册 Filter

1. @WebFilter 属性

属性类型描述filterNameString指定Filter名称，等价于 valueString[]等同于 urlPatterns 属性，两者不应该同时使用urlPatternsString[]指定一组 Filter 的 URL 匹配模式。等价于标签servletNamesString[]指定过滤器将应用于哪些 Servlet。取值于 @WebServlet 中的 name 属性，或者是 web.xml 中 的值initParamsWebInitParam[]指定一组 Filter 初始化参数，等价于标签dispatcherTypesDispatcherType[]指定 Filter 的转发模式，包括：ASYNC、ERROR、FORWARD、INCLUDE、REQUESTasyncSupportedboolean声明 Filter 是否支持异步操作模式，等价于 标签smallIconString此 Filter 的小图标largeIconString此 Filter 的大图标descriptionString该 Filter 的描述信息，等价于 标签displayNameString该 Filter 的显示名，通常配合工具使用，等价于 标签

 

2. 示例

@WebFilter(urlPatterns = { "/TestServlet" }) // 注册拦截器，并添加拦截路径‘/TestServlet’
public class TestFilter implements Filter {

    /**
     * 初始化，只在项目启动的时候执行一次
     */
    @Override
    public void init(FilterConfig filterConfig) {
        System.out.println("===> TestFilter init");
    }
    /**
    * 用于存放过滤器的业务逻辑实现代码
    */
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {

        chain.doFilter(request, response);// 处理请求和响应的分界线
        System.out.println("===> chain.doFilter 后执行处理 response 的相关方法");
        // 在response header里设置一个token
        setToken(response);

    }

    private void setToken(ServletResponse response) {
        HttpServletResponse res = (HttpServletResponse) response;
        String token = UUID.randomUUID().toString();
        res.setHeader("Token", token);
        System.out.println("===> 设置了token：" + token);
    }

    /**
     * 销毁，在项目关闭，Servlet 容器销毁前调用
     */
    @Override
    public void destroy() {
        System.out.println("===> TestFilter destroy");
    }

}

 

3. 测试

浏览器访问 http://127.0.0.1:8080/TestServlet ：

日志打印：

 

 

4. Filter 主要使用场景

• 禁用浏览器的缓存（缓存的处理）
• 解决中文乱码问题
• 登录鉴权及权限管理
• 用户授权，负责检查用户的请求，根据请求过滤用户非法请求
• 日志记录，详细记录某些特殊的用户请求
• 其他场景

 

五、注册 Listener

1. @Listener 属性

属性类型描述valueString侦听器Listener的描述

 

2. 示例

与 ServletContext 相关的监听

Servlet 的监听器 Listener 是实现了 javax.servlet.ServletContextListener 接口的服务器端程序，随着 Web 应用启动而启动，只初始化一次，也随着 Web 应用停止而销毁。其主要作用是做一些初始化的内容添加工作，如参数和对象等。

@WebListener
public class ContextListener implements ServletContextListener, ServletContextAttributeListener{

    public static final String INITIAL_CONTENT = "Content created in servlet Context";

    /**
     * ServletContext创建
     */
    @Override
    public void contextInitialized(ServletContextEvent sce) {
        System.out.println("===> context initialized");
        ServletContext servletContext = sce.getServletContext();
        servletContext.setAttribute("content", INITIAL_CONTENT);
    }

    /**
     * ServletContext销毁
     */
    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        System.out.println("===> context destroyed");
    }

    /**
     * context属性新增
     */
    @Override
    public void attributeAdded(ServletContextAttributeEvent scae) {
        System.out.println("===> context attribute added");
    }

    /**
     * context属性移除
     */
    @Override
    public void attributeRemoved(ServletContextAttributeEvent scae) {
        System.out.println("===> context attribute removed");
    }

    /**
     * context属性替换
     */
    @Override
    public void attributeReplaced(ServletContextAttributeEvent scae) {
        System.out.println("===> context attribute replaced");
    }
}

与 HttpSession 相关的监听

@WebListener
public class SessionListener implements HttpSessionListener, HttpSessionIdListener, HttpSessionAttributeListener,
        HttpSessionActivationListener {

    /**
     * session被创建时
     */
    @Override
    public void sessionCreated(HttpSessionEvent se) {
        System.out.println("===> session created");
    }

    /**
     * session被销毁时
     */
    @Override
    public void sessionDestroyed(HttpSessionEvent se) {
        System.out.println("===> session destroyed");
    }

    /**
     * sessionId改变
     */
    @Override
    public void sessionIdChanged(HttpSessionEvent se, String oldSessionId) {
        System.out.println("===> session id changed");
    }

    /**
     * session属性新增
     */
    @Override
    public void attributeAdded(HttpSessionBindingEvent se) {
        System.out.println("===> session attribute added");
    }

    /**
     * session属性移除
     */
    @Override
    public void attributeRemoved(HttpSessionBindingEvent se) {
        System.out.println("===> session attribute removed");
    }

    /**
     * session属性替换
     */
    @Override
    public void attributeReplaced(HttpSessionBindingEvent se) {
        System.out.println("===> session attribute replaced");
    }
    /**
     * session的钝化，内存的数据写入到硬盘上的过程。
     */
    @Override
    public void sessionWillPassivate(HttpSessionEvent se) {
        System.out.println("===> session will passivate");
    }
    /**
     * session的活化，将硬盘的数据恢复到内存中。
     */
    @Override
    public void sessionDidActivate(HttpSessionEvent se) {
        System.out.println("===> session did activate");
    }

}

与 ServletRequest 相关的监听

@WebListener
public class RequestListener implements ServletRequestListener,ServletRequestAttributeListener {
    /**
     * 请求即将进入Web应用程序的范围/请求初始化时
     */
    @Override
    public void requestInitialized(ServletRequestEvent sre) {
        System.out.println("===> request initialized");
    }
    /**
     * 请求即将进入Web应用程序的范围/请求销毁时
     */
    @Override
    public void requestDestroyed(ServletRequestEvent sre) {
        System.out.println("===> request destroyed");
    }
    /**
     * request属性新增
     */
    @Override
    public void attributeAdded(ServletRequestAttributeEvent srae) {
        System.out.println("===> request attribute added");
    }
    /**
     * request属性移除
     */
    @Override
    public void attributeRemoved(ServletRequestAttributeEvent srae) {
        System.out.println("===> request attribute removed");
    }
    /**
     * request属性替换
     */
    @Override
    public void attributeReplaced(ServletRequestAttributeEvent srae) {
        System.out.println("===> request attribute replaced");
    }
}

 

3. 项目相关日志输入（启动和停止）

先执行 contextInitialzed 方法在执行 TestFilter 类的 init 方法， contextDestroyed 方法在 TestFilter 类 destroy 方法执行后执行。

 

六、注册Interceptor

1. 拦截器概念

拦截器，在AOP(Aspect-Oriented Programming)中用于在某个方法或字段被访问之前，进行拦截，然后在之前或之后加入某些操作。拦截是AOP的一种实现策略。

 

2. 拦截器作用

• 日志记录：记录请求信息的日志，以便进行信息监控、信息统计、计算PV（Page View）等
• 权限检查：如登录检测，进入处理器检测检测是否登录
• 性能监控：通过拦截器在进入处理器之前记录开始时间，在处理完后记录结束时间，从而得到该请求的处理时间。（反向代理，如apache也可以自动记录）；
• 通用行为：读取cookie得到用户信息并将用户对象放入请求，从而方便后续流程使用，还有如提取Locale、Theme信息等，只要是多个处理器都需要的即可使用拦截器实现。

 

3. 拦截器实现

通过实现HandlerInterceptor接口，并重写该接口的三个方法来实现拦截器的自定义:

preHandler(HttpServletRequest request, HttpServletResponse response, Object handler)

方法将在请求处理之前进行调用。SpringMVC中的Interceptor同Filter一样都是链式调用。每个Interceptor的调用会依据它的声明顺序依次执行，而且最先执行的都是Interceptor中的preHandle方法，所以可以在这个方法中进行一些前置初始化操作或者是对当前请求的一个预处理，也可以在这个方法中进行一些判断来决定请求是否要继续进行下去。

该方法的返回值是布尔值Boolean 类型的，当它返回为false时，表示请求结束，后续的Interceptor和Controller都不会再执行；当返回值为true时就会继续调用下一个Interceptor 的preHandle 方法，如果已经是最后一个Interceptor 的时候就会是调用当前请求的Controller 方法。

 

postHandler(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)

在当前请求进行处理之后，也就是Controller 方法调用之后执行，但是它会在DispatcherServlet 进行视图返回渲染之前被调用，所以我们可以在这个方法中对Controller 处理之后的ModelAndView 对象进行操作。

 

afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handle, Exception ex)

该方法也是需要当前对应的Interceptor的preHandle方法的返回值为true时才会执行。顾名思义，该方法将在整个请求结束之后，也就是在DispatcherServlet 渲染了对应的视图之后执行。这个方法的主要作用是用于进行资源清理工作的。

 

4. 示例

@Component
public class TimeInterceptor implements HandlerInterceptor {
    private static final Logger LOG = LoggerFactory.getLogger(TimeInterceptor.class);
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        LOG.info("在请求处理之前进行调用（Controller方法调用之前）");
        request.setAttribute("startTime", System.currentTimeMillis());
        HandlerMethod handlerMethod = (HandlerMethod) handler;
        LOG.info("controller object is {}", handlerMethod.getBean().getClass().getName());
        LOG.info("controller method is {}", handlerMethod.getMethod());

        // 需要返回true，否则请求不会被控制器处理
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        LOG.info("请求处理之后进行调用，但是在视图被渲染之前（Controller方法调用之后），如果异常发生，则该方法不会被调用");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        LOG.info("在整个请求结束之后被调用，也就是在DispatcherServlet 渲染了对应的视图之后执行（主要是用于进行资源清理工作）");
        long startTime = (long) request.getAttribute("startTime");
        LOG.info("time consume is {}", System.currentTimeMillis() - startTime);
    }

与过滤器不同的是，拦截器使用@Component修饰后，在SpringBoot中还需要通过实现WebMvcConfigurer手动注册：

// java配置类
@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Autowired
    private TimeInterceptor timeInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry){
        registry.addInterceptor(timeInterceptor);
    }
}

如果是在SpringMVC中，则需要通过xml文件配置<mvc:interceptors>节点信息。