说明：

1). 使用Maven自带的archetype：maven-archetype-webapp;
2). IDEA集成开发环境下载存在问题，需要增加参数：{archetypeCatalog: internal}
3). 如果IDEA下载依赖jar包的source文件，需要执行：mvn dependency:sources;如果是下载java-doc使用：mvn dependency:resolve -Dclassifier=javadoc.

整个项目的目录结构：

Java Filter Web App目录结构

web.xml:

<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns="http://java.sun.com/xml/ns/javaee"
         xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
                             http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" version="3.0">

    <!-- Servlet Context Name -->
    <display-name>servlet-filter</display-name>

    <welcome-file-list>
        <welcome-file>login.jsp</welcome-file>
        <welcome-file>login.html</welcome-file>
    </welcome-file-list>
    
    ...

</web-app>

为Java Web增加登录(Login)和退出(Logout)Servlet

前端登录页面：$CLASSPATH:webapp/login.html:

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>登录页面</title>
</head>
<body>

<form action="LoginServlet" method="post">

    Username: <input type="text" name="user">
    <br>
    Password: <input type="password" name="pwd">
    <br>
    <input type="submit" value="Login">
</form>
</body>
</html>

登录后处理的Servlet($CLASSPATH:src/main/java/com.fmz.learn.servlet.LoginServlet.java):

package com.fmz.learn.servlet;

import java.io.IOException;
import java.io.PrintWriter;
import javax.servlet.RequestDispatcher;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.*;

/**
 * Servlet implementation class LoginServlet
 * 注解Servlet，不需要在web.xml中配置
 */
@WebServlet("/LoginServlet")
public class LoginServlet extends HttpServlet {
    private static final long serialVersionUID = 1L;
    private final String userID = "admin";
    private final String password = "password";

    protected void doPost(HttpServletRequest request,
                          HttpServletResponse response) throws ServletException, IOException {

        // get request parameters for userID and password
        String user = request.getParameter("user");
        String pwd = request.getParameter("pwd");

        if(userID.equals(user) && password.equals(pwd)){
            HttpSession session = request.getSession();
            session.setAttribute("user", "Pankaj");
            //setting session to expiry in 30 mins
            session.setMaxInactiveInterval(30*60);
            Cookie userName = new Cookie("user", user);
            userName.setMaxAge(30*60);
            response.addCookie(userName);
            //登录成功后跳转的JSP
            response.sendRedirect("LoginSuccess.jsp");
        }else{
            //RequestDispatcher rd = getServletContext().getRequestDispatcher("/login.html");
            response.setContentType("text/html; charset=UTF-8");
            RequestDispatcher rd = getServletContext().getRequestDispatcher("/login.jsp");
            PrintWriter out= response.getWriter();
            out.println("<font color=red>Either user name or password is wrong.</font>");
            rd.include(request, response);
        }

    }
}

登录成功后跳转的JSP($CLASSPATH:webapp/LoginSuccess.jsp):

<%@ page 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>登录成功页面</title>
    </head>

    <body>

        <%
            String user = (String)session.getAttribute("user");
            String userName = null;
            String sessionID = null;
            Cookie[] cookies = request.getCookies();
            if(cookies != null){
                for(Cookie cookie : cookies) {
                    if(cookie.getName().equals("user")) {
                        userName = cookie.getValue();
                    }
                    if(cookie.getName().equals("JSESSIONID")){
                        sessionID = cookie.getValue();
                    }
                }
            }

            String loginName = request.getParameter("user");
        %>

        <h3>这个是登录用户名(用来判断跳转是否是同一个Request):: <%= loginName%></h3>
        <h3>Hi <%=userName %>, Login successful. Your Session ID=<%=sessionID %></h3>
        <br>
        User=<%=user %>
        <br>
        <a href="CheckoutPage.jsp">Checkout Page</a>
        <form action="LogoutServlet" method="post">
        <input type="submit" value="Logout" >
        </form>
    </body>
</html>

登录失败后跳转的JSP($CLASSPATH:webapp/login.jsp):

<%@page session="false" 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>Login Success Page</title>
    </head>

    <body>

    <%
        String loginUser = request.getParameter("user");
    %>
    <h3>用户:: <%= loginUser%>登录失败！</h3>
    <form action="LoginServlet" method="POST">
        Username: <input type="text" name="user">
        <br>
        Password: <input type="password" name="pwd">
        <br>
        <input type="submit" value="Login">
    </form>
    </body>
</html>

退出登录执行的Servlet($CLASSPATH:src/main/java/com.fmz.learn.servlet.LogoutServlet.java)：

package com.fmz.learn.servlet;

import java.io.IOException;

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

/**
 * Servlet implementation class LogoutServlet
 */
@WebServlet("/LogoutServlet")
public class LogoutServlet extends HttpServlet {
    private static final long serialVersionUID = 1L;

    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        response.setContentType("text/html");
        Cookie[] cookies = request.getCookies();
        if(cookies != null){
            for(Cookie cookie : cookies){
                if(cookie.getName().equals("JSESSIONID")){
                    System.out.println("JSESSIONID="+cookie.getValue());
                    break;
                }
            }
        }
        //invalidate the session if exists
        HttpSession session = request.getSession(false);
        System.out.println("User="+session.getAttribute("user"));
        if(session != null){
            session.invalidate();
        }
        response.sendRedirect("login.html");
    }

}

JSP显示乱码：

启动程序后，当输入中文用户名(你好)和密码(d)时，身份认证出现错误，会INCLUDE到Login.jsp，这时候中文显示是乱码的：

jsp显示乱码

通过Chrome监控网络，得到的表单提交封装参数如下：

encode后的表单数据

从图中可以看出来，JSP文件提交表单数据时，通过UTF-8的编码格式(两个汉字编码为三个字节)对user=你好&pwd=d进行编码。那么问题一定是出在了解码的时候，通过修改LoginServlet.java对HttpServletRequest对象设置encoding可以解决编码问题：

request.setCharacterEncoding("UTF-8")

或者从默认的encoding(ISO-8859-1)解码后的字符串中得到bytes，然后重新解码(不建议使用这种方法)：

String user = new String(request.getParameter("user").getBytes("ISO-8859-1"), "UTF-8")

设置编码说明：

如果对JVM设置文件编码格式使用：-Dfile.encoding=UTF-8;

如果对HTTP GET请求的URL设置编码格式(tomcat server.xml设置)：URIEncoding=UTF-8;

如果HTTP POST请求的请求体设置编码格式(上述乱码情况)：request.setCharacterEncoding("UTF-8").

使用Filter增强应用的功能

使用Filter可以在请求到达Servlet(JSP)之前或者请求被Servlet(JSP)处理完之后而响应未到达客户端之前对请求和响应做相应的处理。

Request设置字符编码Filter

可以在请求未到达Servlet时，设置Request的解码字符编码：

package com.fmz.learn.filter;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;

/**
 * Servlet implementation class LoginServlet
 */
@WebFilter(filterName="filter1")
public class SetCharacterEncodingUTF8 implements Filter{

    private ServletContext servletContext;

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        this.servletContext = filterConfig.getServletContext();
        this.servletContext.log("SetCharacterEncodingUTF8 Filter初始化！");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        request.setCharacterEncoding("UTF-8");
        chain.doFilter(request, response);
    }

    @Override
    public void destroy() {

    }
}

在web.xml中定义filter-mapping:

<filter-mapping>
    <filter-name>filter1</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

说明：

1). 使用注解(@WebFilter)的方法设置该类为一个Filter类;
2). 注解(@WebFilter)可以通过@WebFilter(filterName="xxx")自定义指定Filter的filter-name,默认为该类的名字;也可以通过@WebFilter(filterName="xxx", urlPattern="xxx")同时指定url-pattern;
3). filter的执行顺序是按照web.xml中<filter-mapping>定义的先后顺序进行的.如果用了注解的方法,没有在web.xml中定义filter-mapping,则会按照filter类名的字典顺序执行.

请求日志输出Filter

日志输出的Filter类：

package com.fmz.learn.filter;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.util.Enumeration;

@WebFilter(filterName="filter2")
public class RequestLoggingFilter implements Filter {

    private ServletContext servletContext;

    @Override
    public void init(FilterConfig filterConfig) throws ServletException{
        this.servletContext = filterConfig.getServletContext();
        this.servletContext.log("RequestLoggingFilter初始化！");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException{
        HttpServletRequest req = (HttpServletRequest)request;
        Enumeration<String> params = req.getParameterNames();
        while(params.hasMoreElements()){
            String name = params.nextElement();
            String value = req.getParameter(name);
            this.servletContext.log(req.getRemoteAddr() +
                    "::Request Params::{" + name + "=" + value + "}");
        }
        Cookie[] cookies = req.getCookies();
        if(cookies != null){
            for(Cookie cookie : cookies){
                this.servletContext.log(req.getRemoteAddr() +
                        "::Cookie::{" + cookie.getName() + "," + cookie.getValue() + "}");
            }
        }
        chain.doFilter(request, response);
    }

    @Override
    public void destroy(){

    }

}

在web.xml中定义filter-mapping:

<filter-mapping>
    <filter-name>filter2</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

在request.getParameter()之后进行request.setCharacterEncoding()就不起作用了：

在RequestLoggingFilter.java中有取得HttpServletRequest的参数信息，如果filter2是先于filter1执行的，则filter1中request.setCharacterEncoding("UTF-8")就会失去作用。

因此：request.setCharacterEncoding()需要在任意取得参数(request.getParameter())的取参语句之前执行。

用户认证(Authentication)Filter

HttpSession认证filter：

package com.fmz.learn.filter;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import java.io.IOException;

@WebFilter(filterName="filter3")
public class AuthenticationFilter implements Filter{

    private ServletContext servletContext;

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        this.servletContext = filterConfig.getServletContext();
        this.servletContext.log("Authentication初始化！");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        HttpServletRequest request = (HttpServletRequest)servletRequest;
        HttpServletResponse response = (HttpServletResponse)servletResponse;

        String URI = request.getRequestURI();
        this.servletContext.log("Request Source::"  + URI);

        HttpSession session = request.getSession(false);
        if(session == null && !(URI.endsWith("html") ||
            URI.endsWith("LoginServlet"))){
            this.servletContext.log("未经认证的访问！");
            response.sendRedirect("login.html");
        }else{
            filterChain.doFilter(request, response);
            System.out.println("AuthenticationFilter执行完毕！");
        }
    }

    @Override
    public void destroy() {

    }
}

在web.xml中定义filter-mapping:

<filter-mapping>
    <filter-name>filter3</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

说明：

1). 认证的逻辑是：如果session是null且不是获取静态资源(*.html)且请求路径不是(*/LoginServlet)，直接跳转到登录页(login.html);反之，交给LoginServlet进行用户名密码认证;
2). Servlet默认情况下不会创建HttpServletSession，只能通过request.getSession()获取，如果Session不存在就创建一个。如果不想自动创建则使用：request.getSession(false);
3). JSP页面默认会创建HttpServletSession,如果要禁用自动创建，则配置: <@page session="false">.

LoginServlet如果认证用户信息失败，则会跳转到login.jsp，如果不想让JSP文件自动创建Session，需要配置<@page session="false">

RequestDispatcher#include(request, response)到login.jsp乱码问题：

include JSP页面乱码

乱码问题的原因一定是：编码(encode)和解码(decode)所使用的字符编码不一致。

可以通过：response.setContentType("text/html; charset=UTF-8")设置解码格式。

4. Servlet核心相关对象解读

Servlet的核心对象有：ServletContext、HttpServletRequest、HttpServletResponse、HttpSession。

ServletContext

当Servlet容器(例如Apache Tomcat)启动的时候，它将会部署并且加载所有web应用(webapp目录下)。当一个web应用被加载时，Servlet容器将会创建一个ServletContext(仅仅创建一次)并且将它保存在内存中。该web应用的web.xml会被解析，每一个<servlet>、<filter>和<listener>标签(或者是每一个带有@WebServlet、@WebFilter和@WebListener注解的类)对应的servlet、filter和listenre会被初始化(仅仅初始化一次)并且保存在内存中。对于每一个filter对象，它的init()方法会随着一个filterConfig对象被调用。

当Servlet容器关闭时，它会卸载掉所有的web应用。调用所有初始化后的servlet和filter的destroy()方法。所有的ServletContext、servlet、filter和listener对象都会回收掉。

当一个Servlet有标签<servlet><load-on-startup>或者@WebServlet(loadonStartUp)的值大于0时，该Servlet的init()会在Servlet容器启动时伴随着一个ServletConfig对象而初始化(调用init()方法)。这些Servlet会根据load-on-startup的值(1-->1st,2-->2nd,etc)的大小顺序初始化。如果多个Servlet配置了同一个load-on-startup的值，它们的初始化顺序会根据web.xml中配置的顺序或者注解(@WebFilter)类加载的顺序进行初始化。如果Servlet没有配置load-on-startup的值，则相应的初始化工作会在Http请求第一个到达该Servlet时发生。

HttpServletRequest、HttpServletResponse

Servlet Container作为Web Server的扩展总是和Web Server一起工作，Web Server监听某一个端口(开发环境一般是8080，生产环境一般是80)。当客户端通过浏览器发送一个HTTP请求时，Servlet Container会创建一个HttpServletRequest和HttpServletResponse对象，并且将它们传递给任何定义的filter链，最终到达Servlet实例。

当请求到达filter时，doFilter()方法会被调用。当执行代码chain.doFilter(request, response)时，request和response对象会被继续传递给filter链中的下一个filter，直到filter链到头就会进入Servlet实例。

当请求到达servlet时，service()方法会被调用，该方法会根据request.getMethod()来决定调用相应的doXxx()方法，如果相应的doXxx()方法没有被覆写(override)，则会返回HTTP 405错误码。

HttpServletRequest提供了一切HTTP请求的相关信息(请求头和请求体)。HttpServletResponse对象提供了控制和以想要的方式发送Http response的入口，例如，允许你设置response的头信息和body信息(通常通过一个JSP文件生成HTML)。当HTTP response提交完成后，request和response对象都会被回收再利用。

HttpSession

当客户端第一次访问web应用时，Servlet Container通过request.getSession()获取HttpSession对象，产生一个长的唯一的ID(可以通过session.getId()得到)并且将它保存在内存中。Servlet Container同时在response头中设置Set-Cookie项，把JSESSIONID作为该项的名称，唯一的长ID作为该项的值。

根据Http Cookie specification(一个web浏览器和web服务器必须遵守的规范)，客户端(浏览器)必须在该域和路径下的请求中将没有过期Cookie信息返回。Servlet Container会读每一个Http请求的头检查Cookie信息，通过JSESSIONID名获取长的唯一值，并且根据这个值获取与之相关联的内存中的HttpSession。

在Server端，HttpSession将会一直存活着直到超过了web.xml中定义的<session-timeout>时间(默认只是30分钟)。因此，如果30分钟之内没有客户端向服务器端发出请求，HttpSession就会被回收，回收之后如果Http request到达，Servlet Container会创建一个新的HttpSession。

在客户端，Session Cookie一直存活着直到浏览器关闭(所有的TAP都关闭)，在一个新的浏览器实例中，Session Cookie就不存在了，从这里发送的Http请求就会在服务器端生成新的HttpSession，全新的session coolie会被客户端使用。

总结：

ServletContext的生命周期和web应用相同，在所有的HttpServletRequest和HttpSession中共享;
HttpSession和与之相交互的浏览器实例相同，并且session对象不会再服务器端失效，在同一个session中所有HttpServletRequest中共享;
HttpServletRequest和HttpServletResponse的生命周期和Http请求发出到Http响应返回到客户端(web page)相同，它不在任何地方共享;
所有的servlet、filter和listener从应用启动开始存活直到应用关闭，它们在所有的HttpServletRequest和HttpSession中共享;
任何定义在ServletContext、HttpServletRequest和HttpSession中的attribute和该对象的生命周期相同。在Bean管理框架(例如JSP,CDI,Spring等)中的Bean通过Scope代表着这个对象的生命周期;

Servlet的线程安全性:

servlet和filter在所有的请求(Http request)中共享，这样多线程可以使用同一个对象。相反，如果每一个请求都生成一个servlet或者filter对象，都要执行init()和destroy()方法，代价相对会比较大。

同样应该注意：不应该赋值任何request或者session作用域的数据作为servlet或者filter实例数据(instance data)，它们将会被其他Session的request共享，这样是线程非安全的。例如：

public class ExampleServlet extends HttpServlet {

    private Object thisIsNOTThreadSafe;

    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        Object thisIsThreadSafe;

        thisIsNOTThreadSafe = request.getParameter("foo"); // 线程非安全，这个参数在所有的request中共享
        thisIsThreadSafe = request.getParameter("foo"); // OK, this is thread safe.
    } 
}

5. IDEA使用问题

新安装的IDEA使用maven导入项目时，一直好像不识别这是个maven项目，解决办法：

Close your project window (and IntelliJ) and remove all *.iml files and all .idea folders (there should be one per module)（删除项目中.idea和.iml文件）
Run mvn clean install from the command line（maven命令行执行mvn clean install）
Re-import the project into IntelliJ and pay attention when it asks you to enable auto-import（重新导入项目）

参考：https://stackoverflow.com/questions/11454822/import-maven-dependencies-in-intellij-idea?page=1&tab=scoredesc#tab-top

6. Eclipse使用问题

有一个系统前端和后端分开是两个子系统，但是前端要获取后端运行进程的一些状态(例如ps -ef |grep -v grep |grep xxx.jar)。

如果在Windows上进行开发，ps -ef命令无法执行，不能很丝滑的调试。

这时候就想到了用Linux上的IDE Eclipse，下载eclipse jee，解压到Linux系统上就可以使用。

时间长不用eclipse，有些东西还真不知道怎么用了，这里记录一下：

Eclipse IDE for Java Developers，这个版本没有web功能，如果是web项目要下载版本Eclipse IDE for Enterprise Java and Web Developers。
配置Server，Windows –> Preferences –> Server –> Runtime Environment –> 配置Server
视图中调出来Server，Windows –> Show view –> Server

竟然将src也作为了包

src –> Build Path –> Use As Source Folder，这样就可以将一个目录作为源码路径。

识别不了项目是一个web项目

Project –> Properties –> Project Facets，勾选Dynamic Web Module、Java、JavaScript
Project –> Properties –> Deployment Assembly –>
1. /src –> WEB-INF/classes
2. /web –> /
3. /web/WEB-INF/web.xml –> WEB-INF/web.xml
4. Maven Dependencies –> WEB-INF/lib

注意，这里的src是源代码的路径，/web是web路径，可以根据实际项目的定义做出修改。

基本的Java Web Filter总结

当Http请求到达Servlet(JSP)之前或者Servlet(JSP)处理请求完成之后，Filter可以拦截请求，并进行响应的preprocess或者postprocess。本文通过一个简单的登录应用，看一看Filter是如何工作的。

目录

建一个简单的Maven Java Web项目

为Java Web增加登录(Login)和退出(Logout)Servlet

使用Filter增强应用的功能

Request设置字符编码Filter

请求日志输出Filter

用户认证(Authentication)Filter

4. Servlet核心相关对象解读

5. IDEA使用问题

6. Eclipse使用问题