Java `ServletConfig`教程

Java Servlet
Pure.css
Java ServletConfig示例

原文： http://zetcode.com/articles/javaservletconfig/

Java ServletConfig教程展示了如何使用ServletConfig将初始化数据传递给 Servlet。

ServletConfig是 servlet 容器使用的 servlet 配置对象，用于在初始化期间将信息传递给 servlet。 Servlet 容器为 Web 应用中的每个 Servlet 创建一个ServletConfig。

Java Servlet

Servlet 是 Java 类，可响应特定类型的网络请求-最常见的是 HTTP 请求。 Java servlet 用于创建 Web 应用。它们在 servlet 容器（例如 Tomcat 或 Jetty）中运行。现代 Java Web 开发使用在 servlet 之上构建的框架。

Pure.css

Pure.css 是一组小型的响应式 CSS 模块，可以在每个 Web 项目中使用。该库是由 Yahoo 创建的。

Java `ServletConfig`示例

在以下 Web 应用中，我们有一个简单的 Web 表单。我们向 Servlet 发送了一个名称参数。如果参数为空，则通过ServletConfig读取初始化参数。在示例中，我们还使用 Yahoo 的 Pure.css 库。

$ tree
.
├── nb-configuration.xml
├── pom.xml
└── src
    ├── main
    │   ├── java
    │   │   └── com
    │   │       └── zetcode
    │   │           └── web
    │   │               └── MyServlet.java
    │   └── webapp
    │       ├── index.html
    │       ├── META-INF
    │       │   └── context.xml
    │       └── WEB-INF
    └── test
        └── java

这是项目结构。

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" 
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.zetcode</groupId>
    <artifactId>JavaServletConfigEx</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>
    <name>JavaServletConfigEx</name>
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
    </properties>
    <dependencies>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>3.1.0</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-war-plugin</artifactId>
                <version>2.3</version>
                <configuration>
                    <failOnMissingWebXml>false</failOnMissingWebXml>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

这是 Maven pom.xml文件。 javax.servlet-api工件用于 Java Servlet。 maven-war-plugin负责收集 Web 应用的所有工件依赖项，类和资源，并将它们打包到 Web 应用存档（WAR）中。

context.xml

<?xml version="1.0" encoding="UTF-8"?>
<Context path="/JavaServletConfigEx"/>

在 Tomcat context.xml文件中，我们定义了上下文路径。它是 Web 应用的名称。

index.html

<!DOCTYPE html>
<html>
    <head>
        <title>Home Page</title>
        <meta charset="UTF-8">
        <meta name="viewport" content="width=device-width, initial-scale=1">
        <link rel="stylesheet" href="https://unpkg.com/purecss@1.0.0/build/pure-min.css">
    </head>
    <body>
        <form class="pure-form" action="MyServlet">
            <fieldset>
                <legend>Enter your name</legend>
                <input type="text" name="name">
                <button type="submit" class="pure-button pure-button-primary">Submit</button>
            </fieldset>
        </form>
    </body>
</html>

这是主页。它包含一个HTML表格。提交表单后，处理将发送到MyServlet。

<link rel="stylesheet" href="https://unpkg.com/purecss@1.0.0/build/pure-min.css">

我们包括 Pure.css 库。

<form class="pure-form" action="MyServlet">

form标记使用 Pure.css 库中的pure-form类。 action属性指向MyServlet。

<input type="text" name="name">

用户输入的名称值将作为name参数发送到 servlet。

<button type="submit" class="pure-button pure-button-primary">Submit</button>

提交按钮使用pure-button和pure-button-primary类。

MyServlet.java

package com.zetcode.web;
import java.io.IOException;
import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletOutputStream;
import javax.servlet.annotation.WebServlet;
import javax.servlet.annotation.WebInitParam;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@WebServlet(name = "MyServlet", urlPatterns = {"/MyServlet"}, initParams = {
    @WebInitParam(name = "name", value = "Guest")})
public class MyServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        response.setContentType("text/plain;charset=UTF-8");
        String name = request.getParameter("name");
        name = name.trim();
        if (name.isEmpty()) {
            ServletConfig sc = getServletConfig();
            name = sc.getInitParameter("name");
        }
        ServletOutputStream os = response.getOutputStream();
        os.println("Hello " + name);
    }
}

MyServlet从请求中读取name属性并生成输出。输出为纯文本。

@WebServlet(name = "MyServlet", urlPatterns = {"/MyServlet"}, initParams = {
    @WebInitParam(name = "name", value = "Guest")})

使用@WebInitParam，将name参数初始化为"Guest"值。

String name = request.getParameter("name");
name = name.trim();

我们从请求对象和修剪空间读取name参数。

if (name.isEmpty()) {
    ServletConfig sc = getServletConfig();
    name = sc.getInitParameter("name");
}

如果用户未输入任何值，我们将使用ServletConfig读取name初始化参数。使用getServletConfig()检索ServletConfig。使用getInitParameter()检索参数。

ServletOutputStream os = response.getOutputStream();
os.println("Hello " + name);

我们将文本消息写入ServletOutputStream。

在本教程中，我们使用ServletConfig来读取 Java Servlet 中的初始化参数。

Java Servlet

Pure.css

Java ServletConfig示例

Java `ServletConfig`示例