老杜 JavaWeb 讲解

(五) 开发一个带有Servlet（Java小程序）的webapp（重点）

5.1 基本步骤

  1. 在webapps目录下新建一个目录，起名crm（这个crm就是webapp的名字）。当然，也可以是其它项目，比如银行项目，可以创建一个目录bank，办公系统可以创建一个oa。

注意：crm就是这个webapp的根

  1. 在webapp的根下新建一个目录：WEB-INF

注意：这个目录的名字是Servlet规范中规定的，必须全部大写，必须一模一样。必须的必须。

  1. 在WEB-INF目录下新建一个目录：classes

注意：这个目录的名字必须是全部小写的classes。这也是Servlet规范中规定的。另外这个目录下一定存放的是Java程序编译之后的class文件（这里存放的是字节码文件）。

  1. 在WEB-INF目录下新建一个目录：lib

注意：这个目录不是必须的。但如果一个webapp需要第三方的jar包的话，这个jar包要放到这个lib目录下，这个目录的名字也不能随意编写，必须是全部小写的lib。例如java语言连接数据库需要数据库的驱动jar包。那么这个jar包就一定要放到lib目录下。这Servlet规范中规定的。

  1. 在WEB-INF目录下新建一个文件：web.xml

注意：这个文件是必须的，这个文件名必须叫做web.xml。这个文件必须放在这里。一个合法的webapp，web.xml文件是必须的，这个web.xml文件就是一个配置文件，在这个配置文件中描述了请求路径和Servlet类之间的对照关系。

<?xml version="1.0" encoding="UTF-8"?>

<web-app xmlns="https://jakarta.ee/xml/ns/jakartaee"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="https://jakarta.ee/xml/ns/jakartaee
                      https://jakarta.ee/xml/ns/jakartaee/web-app_5_0.xsd"
  version="5.0"
  metadata-complete="true">
	
</web-app>
  1. 编写一个Java程序，这个小Java程序也不能随意开发，这个小java程序必须实现Servlet接口。
  • 这个Servlet接口不在JDK当中。（因为Servlet不是JavaSE了。Servlet属于JavaEE，是另外的一套类库。）
  • Servlet接口（Servlet.class文件）是Oracle提供的。（最原始的是sun公司提供的。）
  • Servlet接口是JavaEE的规范中的一员。
  • Tomcat服务器实现了Servlet规范，所以Tomcat服务器也需要使用Servlet接口。Tomcat服务器中应该有这个接口，Tomcat服务器的CATALINA_HOME\lib目录下有一个servlet-api.jar，解压这个servlet-api.jar之后，你会看到里面有一个Servlet.class文件。
  • 重点：从JakartaEE9开始，Servlet接口的全名变了：jakarta.servlet.Servlet
  • 注意：编写这个Java小程序的时候，java源代码你愿意在哪里就在哪里，位置无所谓，你只需要将java源代码编译之后的class文件放到classes目录下即可。
import jakarta.servlet.Servlet;
import jakarta.servlet.ServletException;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;
import jakarta.servlet.ServletConfig;
import java.io.IOException;
import java.io.PrintWriter;

public class HelloServlet implements Servlet{
	public void init(ServletConfig config) throws ServletException{
		
	}
	
	public void service(ServletRequest request,ServletResponse response) throws ServletException,IOException{
		
		System.out.println("My first Servlet,Hello Servlet!!");
        //向浏览器响应一段HTML代码
        response.setContentType("text/html");
		PrintWriter out = response.getWriter();
		out.print("My first Servlet,Hello Servlet!!");
        out.print("<h1>hello servlet!</h1>");
	}
	
	public void destroy(){
		
	}
	
	public String getServletInfo(){
		return "";
	}

	public ServletConfig getServletConfig(){
		return null;
	}
}
  1. 编译HelloServlet
  • 重点：你怎么能让你的HelloServlet编译通过呢？配置环境变量CLASSPATH
    CLASSPATH=.;C:\dev\apache-tomcat-10.0.12\lib\servlet-api.jar （以自己的地址为准）
  • 思考问题：以上配置的CLASSPATH和Tomcat服务器运行有没有关系？
  • 没有任何关系，以上配置这个环境变量只是为了让你的HelloServlet能够正常编译生成class文件。
  1. 将以上编译之后的HelloServlet.class文件拷贝到WEB-INF\classes目录下。
  2. 在web.xml文件中编写配置信息，让“请求路径”和“Servlet类名”关联在一起。
  • 这一步用专业术语描述：在web.xml文件中注册Servlet类。
<?xml version="1.0" encoding="UTF-8"?>

<web-app xmlns="https://jakarta.ee/xml/ns/jakartaee"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="https://jakarta.ee/xml/ns/jakartaee
                      https://jakarta.ee/xml/ns/jakartaee/web-app_5_0.xsd"
  version="5.0"
  metadata-complete="true">

	<servlet>
		<servlet-name>a1</servlet-name>
		<servlet-class>HelloServlet</servlet-class>
	</servlet>
	
	<servlet-mapping>
		<servlet-name>a1</servlet-name>
		<url-pattern>/first</url-pattern>
	</servlet-mapping>
	
	
</web-app>
  1. 启动Tomcat服务器。
  2. 打开浏览器，在浏览器地址栏上输入一个url，这个URL必须是：
  • 127.0.0.1:8080/crm/first（以自己的地址为准）
  • 非常重要的一件事：浏览器上的请求路径不能随便写，这个请求路径必须和web.xml文件中的url-pattern一致。
  • 注意：浏览器上的请求路径和web.xml文件中的url-pattern的唯一区别就是：浏览器上的请求路径带项目名：/crm

补充：

  • 浏览器上编写的路径太复杂，可以使用超链接。（非常重要：html页面只能放到WEB-INF目录外面。）
  • 以后不需要我们编写main方法了。tomcat服务器负责调用main方法，Tomcat服务器启动的时候执行的就是main方法。我们javaweb程序员只需要编写Servlet接口的实现类，然后将其注册到web.xml文件中，即可。
  • 总结一下：一个合法的webapp目录结构应该是怎样的？
webapproot
     |------WEB-INF
     		  |------classes(存放字节码)
     		  |------lib(第三方jar包)
     		  |------web.xml(注册Servlet)
     |------html
     |------css
     |------javascript
     |------image
     ....
  • 浏览器发送请求，到最终服务器调用Servlet中的方法，是怎样的一个过程？（以下这个过程描述的很粗糙。其中还有很多步骤我省略了。）
  • 用户输入URL，或者直接点击超链接：127.0.0.1:8080/crm/first（以自己的地址为准）
  • 然后Tomcat服务器接收到请求，截取路径：/crm/first
  • Tomcat服务器找到crm项目
  • Tomcat服务器在web.xml文件中查找/first 对应的Servlet是：HelloServlet
  • Tomcat服务器通过反射机制，创建HelloServlet的对象。
  • Tomcat服务器调用HelloServlet对象的service方法。

5.2 解决Tomcat服务器在DOS命令窗口中的乱码问题（控制台乱码）

将CATALINA_HOME/conf/logging.properties文件中的内容修改如下：

java.util.logging.ConsoleHandler.encoding = GBK

5.3 向浏览器响应一段HTML代码

public void service(ServletRequest request, ServletResponse response){
    response.setContentType("text/html");
    PrintWriter out = response.getWriter();
    out.print("<h1>hello servlet!</h1>");
}