Servlet | Servlet原理、开发第一个带有Java小程序Servlet

✅作者简介:一位材料转码农的选手,希望一起努力,一起进步! 

📃个人主页:@每天都要敲代码的个人主页

🔥系列专栏:Web后端 | Servlet

目录

一:模拟实现Servlet

二:开发第一个带有Java小程序Servlet【重点】


一:模拟实现Servlet

有了上一章节的分析,我们来模拟实现以下Servlet;下面先分析一下我们需要做什么:

  • 充当SUN公司的角色,制定Servlet规范

    • javax.servlet.Servlet接口

  • 充当Tomcat服务器的开发者

  • 充当Webapp的开发者

    • UserLoginServlet implements Servlet

充当SUN公司的角色,制定Servlet规范

Tomcat与Webapp之间之所以能够解耦合,是因为有Servlet规范
现在充当的角色是SUN公司,SUN公司把Servlet接口/规范制定出来了

package javax.servlet

public interface Servlet{
	// 一个专门提供服务的方法
	void service();

}

充当Webapp的开发者

充当的角色发生了改变:webapp开发者
只要是我们webapp开发者写的XXXServlet都要实现Servlet接口

package com.bjpowernode.servlet;
import javax.servlet.Servlet;


public class UserLoginServlet implements Servlet{
	public void service(){
		System.out.println("UserLoginServlet's service...");
	}
}

充当Tomcat服务器的开发者

我们输入的请求路径与XXXServlet类有一定的对应关系;对应关系由Webapp的开发者来提供,定义一个属性配置文件:web.properties

/login=com.bjpowernode.servlet.UserLoginServlet
package org.apache;

import java.util.Scanner;
import java.util.Properties;
import java.io.FileReader;
import javax.servlet.Servlet;

// 充当Tomcat服务器的开发者
public class Tomcat{
	public static void main(String[] args) throws Exception{
		System.out.println("Tomcat服务器启动成功,开始接收用户的访问。");

		// 简单的使用Scanner来模拟一下用户的请求
		// 用户访问服务器是通过浏览器上的“请求路径”
		// 也就是说用户请求路径不同,后台执行的Servlet不同。
		
		System.out.print("请输入您的访问路径:");
		Scanner s = new Scanner(System.in);

		// 用户的请求路径  /login
		String key = s.nextLine(); // Tomcat服务器已经获取到了用户的请求路径了。

		// Tomcat服务器应该通过用户的请求路径找对应的XXXServlet
		// 请求路径和XXXServlet之间的关系应该由谁指定呢?
		// 对于Tomcat服务器来说需要解析配置文件
		FileReader reader = new FileReader("web.properties");
		Properties pro = new Properties();
		pro.load(reader);
		reader.close();

		// 通过key获取value
		String className = pro.getProperty(key);
		// 通过反射机制创建对象
		Class c = Class.forName(className);
		Object obj = c.newInstance(); // obj的类型对于Tomcat服务器开发人员来说不知道。
		
		// 但是Tomcat服务器的开发者知道,你写的XXXXServlet一定实现了Servlet接口
		Servlet servlet = (Servlet)obj;
		servlet.service();

	}
}
  • 通过我们的分析:

    • 对于我们javaweb程序员来说,我们只需要做两件事:

      • 编写一个类实现Servlet接口。

      • 将编写的类配置到配置文件中,在配置文件中:指定请求路径和类名的关系。

  • 注意:

    • 这个配置文件的文件名不能乱来。固定的。

    • 这个配置文件的存放路径不能乱来。固定的。

    • 文件名、文件路径都是SUN公司制定的Servlet规范中的明细。

  • 严格意义上来说Servlet其实并不是简单的一个接口:

    • Servlet规范中规定了:

      • 一个合格的webapp应该是一个怎样的目录结构。

      • 一个合格的webapp应该有一个怎样的配置文件。

      • 一个合格的webapp配置文件路径放在哪里。

      • 一个合格的webapp中java程序放在哪里。

      • 这些都是Servlet规范中规定的。

  • Tomcat服务器要遵循Servlet规范。JavaWEB程序员也要遵循这个Servlet规范。这样Tomcat服务器和webapp才能解耦合。

Servlet规范是一个什么规范?

  • 遵循Servlet规范的webapp,这个webapp就可以放在不同的WEB服务器中运行。(因为这个webapp是遵循Servlet规范的)

  • Servlet规范包括什么呢?

    • 规范了哪些接口

    • 规范了哪些类

    • 规范了一个web应用中应该有哪些配置文件

    • 规范了一个web应用中配置文件的名字

    • 规范了一个web应用中配置文件存放的路径

    • 规范了一个web应用中配置文件的内容

    • 规范了一个合法有效的web应用它的目录结构应该是怎样的。

    • .....

二:开发第一个带有Java小程序Servlet【重点】

补充:关于JavaEE的版本

  • JavaEE目前最高版本是 JavaEE8

  • JavaEE被Oracle捐献了,Oracle将JavaEE规范捐献给Apache了。

  • Apache把JavaEE换名了,以后不叫JavaEE了,以后叫做 jakarta EE

  • JavaEE8版本升级之后的"JavaEE 9",不再是"JavaEE9"这个名字了,叫做JakartaEE9

  • JavaEE8的时候对应的Servlet类名是:javax.servlet.Servlet

  • JakartaEE9的时候对应的Servlet类名是:jakarta.servlet.Servlet (包名都换了)

  • 如果你之前的项目还是在使用javax.servlet.Servlet,那么你的项目无法直接部署到Tomcat9+版本上。你只能部署到Tomcat9-版本上。在Tomcat9以及Tomcat9之前的版本中还是能够识别javax.servlet这个包。

开发步骤是怎样的?

  • 第一步:在webapps目录下新建一个目录,起名crm(这个crm就是webapp的名字)。当然,也可以是其它项目,比如银行项目,可以创建一个目录bank,办公系统可以创建一个oa。

    • 注意:crm就是这个webapp的根

  • 第二步:在webapp的根下新建一个目录:WEB-INF

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

  • 第三步:在WEB-INF目录下新建一个目录:classes

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

  • 第四步:在WEB-INF目录下新建一个目录:lib

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

  • 第五步:在WEB-INF目录下新建一个文件:web.xml

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

    • 这个文件最好从其他的webapp中拷贝模板,最好别手写。复制粘贴

<?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>
  • 第六步:编写一个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目录下即可。

package com.bjpowernode.servlet

import jakarta.servlet.Servlet
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{
	// 通过查看帮助文档发现这个接口中有5个方法
	// destroy()、	getServletConfig()、getServletInfo()、
	// init​(ServletConfig config)、	service​(ServletRequest req, ServletResponse res)
	public void init​(ServletConfig config) throws ServletException{
	}

	public void service​(ServletRequest req, ServletResponse res) throws ServletException,IOException{
        // 把内容输出到控制台的
		System.out.println("Hello Servlet!");
	}

	public void destory(){
	}

	public String getServletInfo(){
		return "";
	}

	public ServetConfig getServletConfig(){
	}

}

第七步:编译我们编写的HelloServlet

  • 重点:你怎么能让你的HelloServlet编译通过呢?编译时jakarta.servlet找不到,因为这是JavaEEjar包下的,所以我们需要配置环境变量。

  • 配置环境变量CLASSPATH:classpath就表示类的路径(JDK中没有Servlet接口,这属于JavaEE)

    CLASSPATH=.;C:\Java学习\5.Web后端\工具\apache-tomcat-10.0.12\lib\servlet-api.jar

  • 思考问题:以上配置的CLASSPATH和Tomcat服务器运行有没有关系?

    • 没有任何关系,以上配置这个环境变量只是为了让你的HelloServlet能够正常编译生成class文件。运行时Tomcat是能自己找到servlet-api.jar

第八步:将以上编译之后的HelloServlet.class文件拷贝到WEB-INF\classes目录下。

第九步:在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都对应一个servlet-mapping -->
	<servlet>
		<servlet-name>zl-gh</servlet-name>
		<!--这个位置必须是带有包名的全限定类名-->
		<servlet-class>com.bjpowernode.servlet.HelloServlet</servlet-class>
	</servlet>

	<!--servlet映射信息-->
	<servlet-mapping>
		<!--这个也是随便的,不过这里写的内容要和上面的一样。-->
		<servlet-name>zl-gh</servlet-name>
		<!--这里需要一个路径-->
		<!--这个路径唯一的要求是必须以 / 开始-->
		<!--当前这个路径可以随便写-->
		<url-pattern>/Hello</url-pattern>
	</servlet-mapping>
	
</web-app>

第十步:启动Tomcat服务器,startup.bat

第十一步:打开浏览器,在浏览器地址栏上输入一个url,这个URL必须是:

  • http://127.0.0.1:8080/crm/Hello

  • 重点:浏览器上的请求路径不能随便写,这个请求路径必须和web.xml文件中的url-pattern一致。

  • 注意:浏览器上的请求路径和web.xml文件中的url-pattern的唯一区别就是:浏览器上的请求路径带项目名:/crm

  • 浏览器上编写的路径太复杂,可以使用超链接。(非常重要:html页面只能放到WEB-INF目录外面。是相当于同级目录关系

<!doctype html>
<html>
	<head>
		<title>index page</title>
	</head>
	<body>
		<a href="http://127.0.0.1:8080/crm/Hello">Hello Servlet</a>
	</body>
</html>
  • 以后不需要我们编写main方法了。tomcat服务器负责调用main方法,Tomcat服务器启动的时候执行的就是main方法我们javaweb程序员只需要编写Servlet接口的实现类,然后将其注册到web.xml文件中,即可。

  • 总结:一个合法的webapp目录结构应该是怎样的?

webapproot(webapp根目录下)
     |------WEB-INF
     		  |------classes(存放字节码)
     		  |------lib(第三方jar包)
     		  |------web.xml(注册Servlet)
     |------html
     |------css
     |------javascript
     |------image
     ....

浏览器发送请求,到最终服务器调用Servlet中的方法,是怎样的一个过程?

  • 用户输入URL,或者直接点击超链接:http://127.0.0.1:8080/crm/Hello

  • 然后Tomcat服务器接收到请求,截取路径:/crm/Hello

  • Tomcat服务器找到crm项目

  • Tomcat服务器在web.xml文件中查找Hello对应的Servlet是:com.bjpowernode.servlet.HelloServlet

  • Tomcat服务器通过反射机制,创建com.bjpowernode.servlet.HelloServlet的对象。

  • Tomcat服务器调用com.bjpowernode.servlet.HelloServlet对象的service方法。

上面我们编写实现接口时,重写service​(ServletRequest req, ServletResponse res)方法,是直接把结果输出到控制台的!

那么怎么输出到浏览器上呢?这就需要ServletResponse response接口;response调用getWriter()返回的是一个PrintWriter流,利用这个流在调用print()方法,打印到服务器上,例如:        

     PrintWriter out = response.getWriter();
     out.print("在浏览器上输出打印:Hello Servlet");   
package com.bjpowernode.servlet;

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{

	// 5个方法
	public void init(ServletConfig config) throws ServletException{
	
	}

	public void service(ServletRequest request,ServletResponse response)
		throws ServletException , IOException{

		// 1.直接向控制台打印输出
		System.out.println("My First Servlet, Hello Servlet");

		// 2.向浏览器打印输出
		// 需要使用ServletResponse接口:response 
		// 调用getWriter()方法,这个方法返回的是一个java.io.PrintWriter流
		PrintWriter out = response.getWriter();
		out.print("在浏览器上输出打印:Hello Servlet");

		// 上面是一个输出流,负责输出字符串到浏览器
		// 这个输出流不需要我们刷新,也不需要关闭;这些都是由Tomcat来维护
		// out.flush();
		// out.close();
		
	}

	public void destroy(){
	
	}

	public String getServletInfo(){
		return "";
	}

	public ServletConfig getServletConfig(){
		return null;
	}
}

重新编译运行,在浏览器上输入URL进行访问;这样就会在当前浏览器页面上输出了!

总结:向浏览器响应一段HTML代码,怎么进行设置?

需要调用response的setContentType("text/html")方法,这样就能识别HTML代码

public void service(ServletRequest request, ServletResponse response){
    // 设置识别代码的类型
    response.setContentType("text/html");
    // 设置输出结果打印到浏览器上
    PrintWriter out = response.getWriter();
    out.print("<h1>hello servlet!</h1>");
}

补充:解决Tomcat服务器在DOS命令窗口中的乱码问题(控制台乱码)

CATALINA_HOME/conf/logging.properties文件中的utf-8都GBK!

如下:java.util.logging.ConsoleHandler.encoding = GBK

  • 72
    点赞
  • 59
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 62
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 62
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

@每天都要敲代码

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值