Servlet 常見的註解

sc_ik發表於2019-01-19
Servlet

Serlvet中WebServlet註解

作用: 用於將一個類宣告為 Servlet

描述: 該註解將會在部署時被容器處理, 容器將根據具體的屬性配置將相應的類部署為 Servlet.

屬性詳解: 該註解具有下表給出的一些常用屬性(以下所有屬性均為可選屬性, 但是 vlaue 或者 urlPatterns 通常是必需的, 且二者不能共存, 如果同時指定, 通常是忽略 value 的取值)

屬性名 型別 屬性描述
name String 指定servlet的name屬性,等價於<Servlet-name>.如果沒有顯示指定，則該servlet的取值即為類的全限定名.
value String[] 等價於urlPatterns,二者不能共存.
urlPatterns String[] 指定一組servlet的url的匹配模式,等價於 <url-pattern> 標籤.
loadOnStartup int 指定servlet的載入順序,等價於 <load-on-startup> 標籤.
initParams WebInitParam[] 指定一組初始化引數,等價於 <init-param> 標籤.
asyncSupported boolean 申明servlet是否支援非同步操作模式,等價於 <async-supported> 標籤.
displayName String servlet的顯示名,等價於 <display-name> 標籤.
description String servlet的描述資訊,等價於 <description> 標籤. 
import java.io.IOException;
 
import javax.servlet.ServletConfig;
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;
 
//註解配置  
@WebServlet(displayName = "UserServlet", // 描述
        name = "UserServlet", // servlet名稱
        urlPatterns = { "/user" }, // url
        loadOnStartup = 1, // 啟動項
        initParams = { @WebInitParam(name = "username", value = "張三") }) // 初始化引數
 
public class UserServlet extends HttpServlet {
 
    private String username;
 
    public UserServlet() {
        System.out.println("UserServlet...");
    }
 
    @Override
    public void init(ServletConfig config) throws ServletException {
        // 獲取初始化資訊：張三
        username = config.getInitParameter("username");
    }
 
    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        // 主要內容操作
    }
 
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        // 主要內容操作
        System.out.println(username);
    }
}

@WebFilter註解配置Filter(過濾器)

Filter（過濾器）主要對請求到達前進行處理，也可以在請求結束後進行處理，類似於鏈式。

一個請求可以被多個過濾器攔截到，會依次進入各個Filter中，放行後直至進入Servlet，Servlet處理請求結束後，回到各個Filter繼續執行後面的程式碼，先執行的Filter後執行完。

常用到的地方：

  • 使用者許可權過濾
  • 記錄日誌
  • 字元編碼處理

@WebFilter 常用屬性

屬性名 型別 屬性描述
asyncSupported boolean 指定Filter是否支援非同步模式
dispatcherTypes DispatcherType[] 指定Filter對哪種方式的請求進行過濾. 支援的屬性：ASYNC、ERROR、FORWARD、INCLUDE、REQUEST； 預設過濾所有方式的請求
filterName String Filter名稱
initParams WebInitParam[] 配置引數
displayName String Filter顯示名
servletNames String[] 指定對哪些Servlet進行過濾
urlPatterns/value String[] 兩個屬性作用相同，指定攔截的路徑

使用者許可權過濾示例：

自定義過濾器，實現 javax.servlet.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;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
 
@WebFilter(filterName = "loginFilter", urlPatterns = "/*", initParams = {
        @WebInitParam(name = "loginUI", value = "/home/loginUI"),
        @WebInitParam(name = "loginProcess", value = "home/login"),
        @WebInitParam(name = "encoding", value = "utf-8") })
public class LoginFilter implements Filter {
    private FilterConfig config;
 
    @Override
    public void init(FilterConfig config) throws ServletException {
        this.config = config;
    }
 
    @Override
    public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain)
            throws IOException, ServletException {
        // 獲取配置引數
        String loginUI = config.getInitParameter("loginUI");
        String loginProcess = config.getInitParameter("loginProcess");
        String encoding = config.getInitParameter("encoding");
 
        HttpServletRequest request = (HttpServletRequest) req;
        HttpServletResponse response = (HttpServletResponse) res;
 
        // 設定請求的字符集（post請求方式有效）
        request.setCharacterEncoding(encoding);
 
        // 不帶http://域名:埠的地址
        String uri = request.getRequestURI();
        if (uri.contains(loginUI) || uri.contains(loginProcess)) {
            // 請求的登入，放行
            chain.doFilter(request, response);
        } else {
            if (request.getSession().getAttribute("user") == null) {
                // 重定向到登入頁面
                response.sendRedirect(request.getContextPath() + loginUI);
            } else {
                // 已經登入，放行
                chain.doFilter(request, response);
            }
        }
    }
 
    @Override
    public void destroy() {
        this.config = null;
    }
}

@WebListener 註解

該註解用於將類宣告為監聽器，被 @WebListener 標註的類必須實現以下至少一個介面：

  • ServletContextListener
  • ServletContextAttributeListener
  • ServletRequestListener
  • ServletRequestAttributeListener
  • HttpSessionListener
  • HttpSessionAttributeListener
@WebListener("This is only a demo listener") 
public class SimpleListener implements ServletContextListener{...}

import javax.servlet.ServletRequestEvent;
import javax.servlet.ServletRequestListener;
import javax.servlet.annotation.WebListener;
 
@WebListener
public class Test implements ServletRequestListener {
 
    public Test() {
    }
 
    
    public void requestDestroyed(ServletRequestEvent arg0)  { 
    }
 
    public void requestInitialized(ServletRequestEvent arg0)  { 
    }
    
}

相關文章