java Web开发入门

July 20, 2022

Servlet 入门

Servlet API 由 javaEE 提供

https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServlet.html

servlet 应用运行在容器下，开发时，需要指定其作为 provided 依赖

xml

 <!-- version 的同级，指定打包类型为 war 而非 jar。例如： -->
<groupId>com.mycompany.app</groupId>
<artifactId>my-app</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>war</packaging>


<dependencies>
    <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>javax.servlet-api</artifactId>
        <version>4.0.1</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

仓库地址：https://mvnrepository.com/artifact/javax.servlet/javax.servlet-api

此外，还需要安装 maven-war-plugin 插件，用于打包 war 文件

xml

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-war-plugin</artifactId>
            <version>3.2.2</version>
        </plugin>
    </plugins>
</build>

仓库地址：https://mvnrepository.com/artifact/org.apache.maven.plugins/maven-war-plugin

在项目的源文件目录下，编写如下代码

java

// HelloServlet.java

package com.mycompany.app;

import javax.servlet.http.*;
import javax.servlet.annotation.*;
import java.io.*;

@WebServlet(urlPatterns = "/")
public class HelloServlet extends HttpServlet {
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
        resp.setContentType("text/html");
        PrintWriter pw = resp.getWriter();
        pw.write("<h1>Hello, world!</h1>");
        pw.flush();
    }
}

目录结构如下

my-app
 │  pom.xml
 └─src
     ├─main
     │  └─java
     │      └─com
     │          └─mycompany
     │              └─app
     │                      HelloServlet.java
     │
     └─test
         └─java
             └─com
                 └─mycompany
                     └─app

运行命令

mvn clean package

在 target 目录下就得到 my-app-1.0-SNAPSHOT.war 文件

运行 servlet 的容器选择 tomcat，在这里下载 tomcat9（该版本支持 Servlet 4.0, JSP 2.3, EL 3.0, WebSocket 1.1, JASPIC 1.1, java 8 及以上）
tomcat10 开始，提供的 API 主要包已从 javax 改为 jakarta。关于不同版本的区别，查看：https://tomcat.apache.org/whichversion.html

tomcat 有如下文件结构

apache-tomcat-9.0.64
  ├─bin
  ├─conf
  ├─lib
  ├─logs
  ├─temp
  ├─webapps
  └─work

其中 webapps 目录已经有一些 servlet 应用了

webapps
 ├─app
 ├─docs
 ├─examples
 ├─host-manager
 ├─manager
 └─ROOT
     └─WEB-INF

运行 apache-tomcat-9.0.64/bin/startup.sh 脚本（windows 下一律为 .bat ，命令行或者双击即可运行），以启动 tomcat 服务器

之后，tomcat 便运行在 8080 端口上

访问 http://localhost:8080/ ，若出现 Tomcat 页面，则表示启动成功

并且，此时运行的 servlet 应用，正是 webapps/ROOT 对应的程序

访问 http://localhost:8080/examples/ ，则对应 webapps/example 程序

将 my-app-1.0-SNAPSHOT.war 文件置于 webapps 目录下，浏览器访问 http://localhost:8080/my-app-1.0-SNAPSHOT/，则显示刚才编写的程序

Windows 下 tomcat 控制台输出乱码，可修改 conf/logging.properties 文件只需修改下面这行配置即可 java.util.logging.ConsoleHandler.encoding = GBK

Servlet 使用

https://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html
https://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html
https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html
https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletResponse.html

java

package com.mycompany.app;

import javax.servlet.ServletException;
import javax.servlet.http.*;
import javax.servlet.annotation.*;
import java.io.*;
import java.util.*;
import java.util.concurrent.*;

@WebServlet(urlPatterns = "/test") // 其中，'/' 路径不仅匹配根路径，还匹配所有未匹配路径
public class HelloServlet extends HttpServlet {
    // Servlet中定义的字段，需要考虑多线程并发访问
    private Map<String, String> map = new ConcurrentHashMap<>();

    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
        resp.setContentType("text/html");

        Map<String, String[]> query = req.getParameterMap(); // query string
        String method = req.getMethod();
        String uri = req.getRequestURI();

        PrintWriter pw = resp.getWriter();
        pw.write(method);
        pw.write(uri);
        pw.write(query.toString());
        pw.flush();
    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws IOException, ServletException {
        // ...
        // 此时即面向 HttpServletRequest 和 HttpServletResponse 编程
        // 注意 HttpServletRequest 继承了 ServletRequest，HttpServletResponse 继承了 ServletResponse

        req.getRequestDispatcher("/").forward(req, resp); // 转发给其它servlet

        resp.sendRedirect("/hi"); // 302

        resp.setStatus(HttpServletResponse.SC_MOVED_PERMANENTLY); // 301
        resp.setHeader("Location", "/hello");
    }
}

JSP

jsp 了解即可。

jsp 的访问规则类似于 php

在 my-app/src/main/webapp 目录新建 index.jsp，内容如下：

index.jsp

<html>
    <head>
        <title>Hello World - JSP</title>
    </head>
    <body>
        <%-- JSP Comment --%>
        <h1>Hello World!</h1>
        <p>
            <% out.println("Your IP address is "); %>
            <span style="color:red"> <%= request.getRemoteAddr() %> </span>
        </p>
    </body>
</html>

其中，JSP 内置了几个变量：

out：表示 HttpServletResponse 的 PrintWriter；
session：表示当前 HttpSession 对象；
request：表示 HttpServletRequest 对象。

Filter

Filter 可以在 HTTP 请求到达 Servlet 之前，对 ServletRequest 和 ServletResponse 进行一些预处理（一般是一些公共逻辑）
多个 Filter 可以链式处理

java

@WebFilter(urlPatterns = "/*")
public class EncodingFilter implements Filter {
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        request.setCharacterEncoding("UTF-8");
        response.setCharacterEncoding("UTF-8");
        chain.doFilter(request, response); // 允许链式Filter
    }
}

@WebFilter("/*")
public class LogFilter implements Filter {
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        System.out.println("LogFilter: process " + ((HttpServletRequest) request).getRequestURI());
        chain.doFilter(request, response);
    }
}

注意，一般情况下都调用 chain.doFilter(request, response)，否则将不会移交下一个 Filter 处理

Listener

Listener 在触发某些生命周期时，调用回调

java

@WebListener
public class AppListener implements ServletContextListener {
    public void contextInitialized(ServletContextEvent sce) {
        System.out.println("WebApp initialized: ServletContext = " + sce.getServletContext());
    }
    public void contextDestroyed(ServletContextEvent sce) {
        System.out.println("WebApp destroyed.");
    }
    public void HttpSessionListener(ServletContextEvent sce) {}
    public void ServletRequestListener(ServletContextEvent sce) {}
    public void ServletRequestAttributeListener(ServletContextEvent sce) {}
    public void ServletContextAttributeListener(ServletContextEvent sce) {}
}

←Back to home

This work is licensed under CC BY-NC-SA 4.0