Servlet

2020-10-10 技术笔记►Web后端 Java, 后端 0 评论字数统计: 4k(字) 阅读时长: 16(分)

servlet简介

Servlet：即Server Applet。
Servlet其实就是一个遵循Servlet开发的java类。Servlet是由服务器调用的，运行在服务器端。Servlet没有main方法，它的创建、使用、销毁都由Servlet容器(即web服务器）进行管理（如Tomcat：提供了Servlet功能的服务器称作Servlet容器）。即虽然没有main方法，但是通过Servlet容器可以自动调用。
servelet用来实现对服务器的动态资源的控制。
servelet就是一个接口，定义了java类被浏览器访问的规则。
我们需要自定义一个类，这个类实现servelet接口，复写其方法。
Servlet带给我们最大的作用就是能够处理浏览器带来HTTP请求，并返回一个响应给浏览器，从而实现浏览器和服务器的交互。servlet是作用于服务器这一端。

快速入门

IDEA上配置tomcat

使用的ide是IDEA，需要先在IDEA上配置Tomcat。(需要IDEA的utilmate版).
1. 点击Run—EDit Configurations…
  
  2.点击左侧“+”号，找到Tomcat Server—Local。
  
  3.找到tomcat存放位置并配置到idea中：
IDEA会为每一个tomcat部署的项目单独建立一份配置文件
- 查看控制台的log找到这个配置文件的存储位置：CATALINA_BASE: /home/zestaken/.cache/JetBrains/IntelliJIdea2020.2/tomcat/Tomcat_9_0_411_tomcat3
WEB-INF目录下的资源不能被浏览器直接访问。

编写servlet程序的步骤

创建javaEE项目
定义一个类，实现Servlet接口：public class ServletDemo1 implements Servlet
实现接口中的抽象方法
配置servlet，在web.xml中

<!-- 配置Servlet -->
<servlet>
        <servlet-name>demo1</servlet-name>
        <servlet-class>web.ServletDemo1</servlet-class>
    </servlet>
    
    <servlet-mapping>
        <servlet-name>demo1</servlet-name>
        <url-pattern>/demo1</url-pattern>
    </servlet-mapping>

执行原理/解析过程

当服务器接受到浏览器的请求后，会解析URL路径，获取访问的Servlet的资源路径。
查找web.xml文件，是否有对应的<url-pattern>标签内容。
如果有，则再找到对应的<servlet-class>全类名。
tomcat会将字节码文件加载进内存，并且创建其对象。
调用其方法。

生命周期

方法

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

public class ServletDemo1 implements Servlet {
    /**
     * 初始化方法
     * 在servlet被创建时执行，只会执行一次
     * @param servletConfig
     * @throws ServletException
     */
    @Override
    public void init(ServletConfig servletConfig) throws ServletException {
        System.out.println("init");
    }

    /**
     * 获取ServletConfig对象
     * ServletConfig：Servlet的配置对象
     * @return
     */
    @Override
    public ServletConfig getServletConfig() {
        return null;
    }

    /**
     * 提供服务的方法
     * 每一次Servlet被访问时，执行，可以执行多次（每刷新一次页面都会执行一次）
     * @param servletRequest
     * @param servletResponse
     * @throws ServletException
     * @throws IOException
     */
    @Override
    public void service(ServletRequest servletRequest, ServletResponse servletResponse) throws ServletException, IOException {
        System.out.println("service");
    }

    /**
     * 获取Servlet的一些信息，版本，作者等。
     * @return
     */
    @Override
    public String getServletInfo() {
        return null;
    }

    /**
     * 销毁方法
     * 在服务器正常关闭时执行一次。
     */
    @Override
    public void destroy() {
        System.out.println("destroy");
    }
}

生命周期
1. 被创建：执行init方法，只执行一次,一般用于加载资源.
  1. Servlet被创建的时间
    1. 默认情况下，第一次被访问时（即在浏览器中访问该页面时），Servlet被创建
    2. 可以在web.xml配置执行Servlet的创建时间：
      - 在<servlet>标签下配置
        
        第一次被访问时创建:<load-on-startup>的值为负数
        
        在服务器启动时创建：<load-on-startup>的值为0或者正数。
  2. Servlet的init方法，只执行一次，说明一个Servlet在内存中只存在一个对象，Servlet是单例的
    1. 多个用户同时访问时，可能存在线程安全问题。
    2. 解决：尽量不再在Servlet中定义成员变量，即使定义了，也不要修改它。
2. 提供服务：执行service方法，可执行多次
  1. 每次被访问Servlet时，Service方法都会被调用一次。
3. 被销毁：执行destroy方法，只执行一次
  1. Servlet被销毁时执行。
  2. 服务器关闭时，Servlet被销毁
  3. 只有服务器正常关闭时，才会执行destroy方法
  4. destroy方法在Servlet被销毁之前执行，一般用于释放资源。

注解配置

Servlet3.0之后，**支持注解配置，可以不用写web.xml了。
步骤：
1. 创建JavaEE项目，选择Servlet的版本3.0以上，可以不创建web.xml(也可以创建，因为注解配置会覆盖web.xml的配置)
2. 定义一个类，实现Servlet接口;
3. 复写方法;
4. 在类上使用@WebServlet注解，进行配置：
  1. @WebServlet(loadOnStartup="资源路径名")与@WebServlet(value="资源路径名")与@WebServlet("资源路径名")等效。
@WebServlet注解的具体内容：

package javax.servlet.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface WebServlet {
    String name() default "";

    String[] value() default {};

    String[] urlPatterns() default {};

    int loadOnStartup() default -1;

    WebInitParam[] initParams() default {};

    boolean asyncSupported() default false;

    String smallIcon() default "";

    String largeIcon() default "";

    String description() default "";

    String displayName() default "";
}

urlparttern的配置

一个Servlet可以定义多个访问路径，@WebServlet({"/d4"."/dd4"}),如果只有一个路径，则大括号可以省略。
路径的定义规则：
1. /xxx;
2. /xxx/xxx:多层路径，目录结构(不止可以写两层，可以写更多层)
3. *.xxx:不管.之前写的是什么，只要最后的后缀一样即可访问。一般是*.do形式。
通配符*:*所占的位置输入任何名字都可以，但是优先级很低（即如果有那个名字的资源，则访问那个资源）。

Servlet的体系结构

Servlet接口：最上层。
GenericServlet:实现了Servlet接口的抽象类,处于第二层。
- 将Servlet接口中的其他的方法都做了默认空实现，只将service()方法作为抽象。
- 将来定义Servlet的类时，可以继承GenericServlet，实现service()方法即可。（但是不常用）
HttpServlet：继承自GenricServlet的抽象类,处于第三层。
- 所有方法都没有要求实现。
- 对http协议的一种封装，简化操作。
- 使用：
  - 定义类继承HttpServlet
  - 复写doGet()/doPost()等方法。

JAVAWEB的目录结构

bbs目录代表一个web应用
bbs目录下的html,jsp文件可以直接被浏览器访问
WEB-INF目录下的资源是不能直接被浏览器访问的
web.xml文件是web程序的主要配置文件。
所有的classes文件都放在classes目录下
jar文件放在lib目录下。

Request对象和Resoponse对象

服务器与客户端交互流程

tomcat服务器会根据请求url中的资源路径创建对应的实现Servlet的类的对象;
tomcat服务器会创建request和response对象，request对象中封装请求的消息数据;
tomcat将request和response对象传递给service方法，并且调用service方法;
程序员通过request对象获取请求的消息数据，通过response对象**设置响应的消息数据;
服务器在给浏览器做出响应之前会从response对象中拿程序员设置的响应消息数据。

Request对象

原理：
- request对象和reponse对象是由服务器创建的;
- request对象获取请求消息，response对象设置响应消息。
request对象的继承体系结构：
1. ServletRequest:最上层接口;
2. HttpServletRequest:继承自ServletRequest的接口;
3. org.apache.catalina.connector.RequestFacade：tomcat实现的实现了HttpServlet接口的类。

request功能

获取请求消息数据

获取请求行数据：（get方式就放在doget方法中，POST方法则放在dopost方法中）
获取虚拟目录：/tomcat3_war_exploded
String getContextPath();
获取请求的URI或URL:
1. String getRequestURI();:获取URI，如：/tomcat3_war_exploded/ServletDemo3
2. String getRequestURL();获取URL，如：http://localhost:8080/tomcat3_war_exploded/ServletDemo3
3. URI和URL都是统一资源定位符,但是URI表示的范围比URL大。
获取Servlet路径：/ServletDemo3
1. String getServletPath();
获取get方式请求参数：
1. String getQueryString();,如：name=%22zhangsan%22&age=13
获取请求头数据：
1. String getHeader(String name):通过请求头的名称获取请求头的数据;
2. Enumeration<String> getHeaderName():获取所有的请求头数据;
获取请求体数据：
1. 请求体：只有POST方式才有。
2. 步骤：
  1. 获取流对象：
    1. BufferedReader getReader();获取字符输入流，只能操作字符数据;
    2. ServletInputStream getInputStream():获取字节输入流，可以操作所有类型的数据；
  2. 从流对象中将数据拿出来

获取请求参数的通用方式

不论是get还是post方式都可以使用。（如果doget和dopost的代码完全一样的话，在doget里写this.doPost()即可)

根据参数名称来获取参数值:String getParameter(String name)，如果一个参数有多个值的话，则无法获取完。
根据参数名称来获取参数值的数组：String[] getParameterValues(String name);
获取所有请求的参数名称：Enumeration<String> getParameterNames();
获取所有参数的Map集合：Map<String, String[]> getParameterMap()。

获取请求参数的中文乱码问题：
- get方式：tomcat 8 已经将get方式乱码问题解决了;
- post方式：在获取参数前，设置request的编码request.setCharacterEncoding("utf-8");

请求转发(forward)

在服务器内部之间的资源跳转方式。
步骤：
1. 通过request对象来获取请求转发器对象：RequestDispatcher getRequestDispatcher(String path)
2. 使用RequestDispatcher对象来进行转发：forward(ServletRequest request, ServletResponse response)
3. 示例：request.getRequestDispathcher("/ServletDemo4").forward(request,response)
特点：
- 浏览器地址栏路径不会发生变化;
- 只能转发到当前服务器内部资源中;
- 转发是一次请求（即多个资源共用一次请求的信息）。

共享数据

域对象：一个有作用范围的对象，可以在范围内共享数据;
request域：代表一次请求的范围，一般用于请求转发的多个资源中共享数据;
request共享数据的方法：
- 存储数据：void setAttribute(String name, Object obj);
- 通过键获取值：Object getAttribute(String name);
- 通过键移除值对：void removeAttribute(String name);

获取ServletContext对象

request对象获取ServletContext对象的方法：ServletContext getServletContext();

Response对象

功能：设置响应消息
设置响应消息:
- setStatus(int sc)
设置响应头:
- setHeader(String name , String value)
设置响应体:
1. 获取输出流：
  1. 字符输出流：PrintWrtier getWriter()
  2. 字节输出流：ServletOutputStream getOutputStream()
2. 使用输出流：将数据输出到客户端浏览器。

使用案例

重定向（redirect)

资源的跳转方式
方式一：逐步设置响应状态码和响应头

@WebServlet("/ServletDemo2")
public class ServletDemo2 extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {

     System.out.println("demo2");
    resp.setStatus(302);
    resp.setHeader("location", "/tomcat3_war_exploded/ServletDemo3");
    }
}

@WebServlet("/ServletDemo3")
public class ServletDemo3 extends HttpServlet {
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {

    }

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

        System.out.println("demo3");
    }
}

方式二：直接使用sendRedirect方法

@WebServlet("/ServletDemo2")
public class ServletDemo2 extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {

     System.out.println("demo2");
     //动态获取虚拟目录
     String contextPath = req.getContextPath();
     resp.sendRedirect(contextpath+"/ServletDemo3");
    // resp.sendRedirect("/tomcat3_war_exploded/ServletDemo3");
    }
}

@WebServlet("/ServletDemo3")
public class ServletDemo3 extends HttpServlet {
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {

    }

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

        System.out.println("demo3");
    }
}

转发的特点：
- 浏览器地址栏路径不会发生变化;
- 只能转发到当前服务器内部资源中;
- 转发是一次请求（即多个资源共用一次请求的信息），可以使用request对象来共享数据。
重定向的特点：
- 浏览器地址栏路径会发生变化;
- 重定向可以访问**其他站点（服务器）**资源;
- 重定向是两次请求。不能使用request对象来共享数据。
动态方式获取虚拟目录。String contextPath = request.getContextPath();
路径写法：
- 相对路径：
  - 不以/开头，以.开头;
  - 规则：
    - ./：当前目录下;
    - ../：上一级目录下;
- 绝对路径：
  - 以/开头的路径;
  - 给客户端浏览器使用的绝对路径需要加虚拟目录(项目的访问路径);
    - 建议虚拟目录动态获取;
    - 如：重定向中使用的路径是/tomcat3_war_exploded/ServletDemo3
  - 给服务器使用，不需要加虚拟目录;
    - 如转发中使用的路径：/ServletDemo3

服务器输出字符数据到浏览器

步骤：
1. 获取字符输出流：PrintWriter pw = response.getWriter();(获取的流的默认编码是ISO-8859-1)
2. 输出数据：pw.write("你好 response")
3. 流对象是由response创建的，会随着response的关闭而关闭，不用再人为的close。
中文乱码问题：
- 原因：因为浏览器使用的字符集和服务器使用的字符集不一致导致的。
- 需要在获取字符输出流之前返回一个告诉浏览器服务器返回消息使用的字符集和格式：
  - 通过设置content-type头的内容来解决：response.setHeader("content-type", "text/html;charset=utf-8");
  - response对象有一个内置的简化方法：responde.setContentType("text/html;charset=utf-8");

服务器输出字节数据到浏览器

步骤：
1. 获取字节输出流：ServletOutputStream sos = response.getOutputStream();
2. 输出数据：sos.write("你好".getBytes("utf-8"));
还是需要在获取字节输出流之前通知浏览器字符集的设置。

服务器验证码

验证码的作用：防止恶意重复提交表单。（机器人）
实现的功能，服务器自动生成验证码图片，并且对图片进行美化。
步骤：
1. 创建图片
2. 美化图片（增加验证码的内容）
3. 输出图片到浏览器上
示例：

    //图片长宽设置
    int width = 100;
    int height = 50;
    
    //1.创建一对象，在内存中创建图片（验证码的图片）
    BufferedImage image = new BufferedImage(width, height,BufferedImage.TYPE_INT_RGB);

    //2.美化图片
    Graphics g = image.getGraphics();//获取画笔对象
    g.setColor(Color.PINK);//设置画笔颜色
    g.fillRect(0,0,width,height);//填充背景色
    g.setColor(Color.BLACK);//设置画笔颜色
    g.drawRect(0,0,width-1, height - 1);//画边框

    String str = "QWERTYUIOOOOOPASDFGHJKKLZXCVBNMMqwertyuiopasdfghjklzxcvbnm0123456789";//设置可以写到验证码图片上的字符
    Random random = new Random();//获取生成随机数的对象
    //将随即字符写到图片上去
    for(int i = 1; i < 5; i++) {
        int index = random.nextInt(str.length());//获取在字符串大小范围内的随机索引值
        char ch = str.charAt(index);
        g.drawString(ch+"", width/5*i ,height/2);
    }
    
    //画干扰线
    g.setColor(Color.GREEN);

    //生成随机坐标来划线
    for(int i = 0; i < 10; i++) {
        int x1 = random.nextInt(width);
        int x2 = random.nextInt(width);
        int y1 = random.nextInt(height);
        int y2 = random.nextInt(height);
        g.drawLine(x1,y1,x2,y2);
    }

    //3.将图片输出到浏览器上
    ImageIO.write(image, "jpg", resp.getOutputStream());
}

ServletContext对象

概念:代表整个web应用（一个web应用里只有唯一的一个ServletContext对象），可以和程序的容器（服务器）来通信;
获取ServletContext对象：
1. 通过Request对象来获取:request.getServletContext();
2. 通过HttpServlet获取（我们创建的Servlet类都是从这里继承的）：this.getServletContext();
方法：
1. 获取MIME类型：
  1. MIME类型：在互联网通信过程中定义的一种文件数据类型，格式为：大类型/小类型，如：text/html,image/jpeg.
  2. 获取的方法：String getMIMEType(String file),参数是文件名称;
2. 作为域对象：
  1. ServletContext对象的范围：所有用户所有请求的数据;
  2. setAttribute(String name, Object value);
  3. getAttribute(String name)
  4. removeAttribute(String name)
3. 获取文件的真实（服务器）路径：
  1. 我们经常需要使用的是一个文件部署到服务器上的路径，而不是该文件在本地工作空间的路径;
  2. 方法：String getRealPath(String path)
  3. 参数：文件在本地工作空间的相对路径
    1. 在web目录下的资源：/文件名
    2. 在WEB_INF目录下的资源：/WEB-INF/文件名
    3. 在源文件（src目录或者java目录下）的资源：/WEB-INF/classes/文件名

本文链接： http://www.zestaken.top/post/技术笔记/Web后端/Servlet/index.html

版权声明： 本博客所有文章除特别声明外，均采用 CC BY 4.0 CN协议许可协议。转载请注明出处！

Zestaken计算机小白一枚

吾好梦中读书~