Servlet

Servlet

简介

• Servlet就是sun公司开发动态web的一门技术。
• Sun在这些API中提供一个接口叫做：Servlet,如果你想开发一个 Servlet程序，只需要完成两个小步骤：
  • 编写一个类，实现 Servlet接口。
  • 把开发好的Java类部署到Web服务器中。

把实现了Servlet接口的Java程序叫做Servlet

HelloServlet

Servlet接口Sun公司有两个默认的实现类：HttpServlet，GenericServlet。

1. 构建一个普通的 Maven项目，删掉里面的src目录，以后我们的学习就在这个项目里面建立 Moudel；这个空的
   工程就是 Maven主工程。

2. 关于Maven父子工程的理解：

   父项目中会有

   <modules>
   	<module>servlet01</module>
   </modules>
   

   子项目中会有

   <parent>
   	<groupId>com.yt</groupId>
   	<artifactId>javaweb-02-servlet</artifactId>
   	<version>1.0-SNAPSHOT</version>
   </parent>
   

   父项目中的Java子项目可以直接使用

   son extends father
   

3. Maven环境优化

   1. 修改web.xml为最新
   2. 将Maven的结构搭建完整

4. 编写一个Servlet程序

   1. 编写一个普通类

   2. 实现Servlet接口，直接继承HttpServlet

   3. public class HelloServlet extends HttpServlet {
          //由于get或者post只是请求实现的不同的方式，可以相互调用，业务逻辑都一样
      
          @Override
          protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
              super.doGet(req, resp);
              PrintWriter writer = resp.getWriter();
              writer.println("Hello Servlet");
          }
      
          @Override
          protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
              doGet(req, resp);
          }
      }
      

5. 编写 Servlet的映射

   为什么需要映射：我们写的是Java程序，但是要通过浏览器访问，而浏览器需要连接Web服务器，所以我们需
   要再Web服务中注册我们写的Servlet,还需给他一个浏览器能够访问的路径；

   <!--注册Servlet-->
   <servlet>
       <servlet-name>hello</servlet-name>
       <servlet-class>com.yt.servlet.HelloServlet</servlet-class>
   </servlet>
   <!--Servlet的请求路径-->
   <servlet-mapping>
       <servlet-name>hello</servlet-name>
       <url-pattern>/hello</url-pattern>
   </servlet-mapping>
   

   注意：

   url-pattern的里面少了一个"/"，会导致这样的错误：

   严重 [RMI TCP Connection(2)-127.0.0.1] org.apache.tomcat.util.modeler.BaseModelMBean.invoke 调用方法[manageApp]时发生异常
   	java.lang.IllegalStateException: 启动子级时出错
   

6. 配置Tomcat

   注意：配置项目发布的路径

7. 启动测试

Servlet原理

Servlet是由Web服务器调用，Web服务器在收到浏览器请求之后，会：

Mapping问题

1. 一个 Servlet可以指定一个映射路径

   <servlet-mapping>
       <servlet-name>hello</servlet-name>
       <url-pattern>/hello</url-pattern>
   </servlet-mapping>
   

2. 一个 Servlet可以指定多个映射路径

   <servlet-mapping>
       <servlet-name>hello</servlet-name>
       <url-pattern>/hello</url-pattern>
   </servlet-mapping>
   <servlet-mapping>
       <servlet-name>hello</servlet-name>
       <url-pattern>/hello1</url-pattern>
   </servlet-mapping>
   <servlet-mapping>
       <servlet-name>hello</servlet-name>
       <url-pattern>/hello2</url-pattern>
   </servlet-mapping>
   <servlet-mapping>
       <servlet-name>hello</servlet-name>
       <url-pattern>/hello3</url-pattern>
   </servlet-mapping>
   

3. 一个 Servlet可以指定通用映射路径

   <servlet-mapping>
       <servlet-name>hello</servlet-name>
       <url-pattern>/hello/*</url-pattern>
   </servlet-mapping>
   

4. 默认请求路径

   <!--默认请求路径-->
   <servlet-mapping>
       <servlet-name>hello</servlet-name>
       <url-pattern>/*</url-pattern>
   </servlet-mapping>
   

5. 指定一些后缀或者前缀等等

    <!--可以自定义后缀实现请求映射
	注意点，*前面不能加项目映射的路径-->
	<servlet-mapping>
        <servlet-name>hello</servlet-name>
        <url-pattern>*.yt</url-pattern>
    </servlet-mapping>

6. 优先级问题

   指定了固有的映射路径优先级最高，如果找不到就会走默认的处理请求；

ServletContext

Web容器在启动的时候，它会为每个Web程序都创建一个对应的 ServletContext对象，它代表了当前的Web应用。

共享数据

我在这个 Servlet中保存的数据，可以在另外一个 Servlet中拿到。

例子：

@WebServlet("/hello")
public class HelloServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //this.getInitParameter() 初始化参数
        //this.getServletConfig() 配置
        //this.getServletContext() 上下文
        ServletContext servletContext = this.getServletContext();
        System.out.println("hello");

        String username = "杨涛";
        servletContext.setAttribute("username",username);
    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        super.doPost(req, resp);
    }
}

@WebServlet("/get")
public class GetServlet extends HttpServlet{
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        ServletContext servletContext = this.getServletContext();
        String username = (String) servletContext.getAttribute("username");
        resp.setContentType("text/html");
        resp.setCharacterEncoding("utf-8");
        resp.getWriter().println(username);
    }
}

获取初始化参数

<!--配置一些web应用的初始化参数-->
<context-param>
    <param-name>url</param-name>
    <param-value>jetbrains://idea/navigate/reference?project=javaweb-02-servlet&amp;path=request.jsp</param-value>
</context-param>

@WebServlet("/s3")
public class Servlet03 extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        ServletContext servletContext = this.getServletContext();
        String url = servletContext.getInitParameter("url");
        resp.setContentType("text/html");
        resp.setCharacterEncoding("utf-8");
        resp.getWriter().println(url);
    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        super.doPost(req, resp);
    }
}

请求转发

@WebServlet("/s4")
public class Servlet04 extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        ServletContext servletContext = this.getServletContext();
        //转发请求路径，调用forward实现请求转发
        servletContext.getRequestDispatcher("/s3").forward(req,resp);
    }
}

读取资源文件

Properties

• 在Java目录下新建 properties
• 在 resourcese目录下新建 properties

发现：都被打包到了同一个路径下：classes 我们俗称这个路径为 classpath。

思路：需要一个文件流

username=root
password=root

@WebServlet("/s5")
public class PropertiesServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        InputStream is = this.getServletContext().getResourceAsStream("/WEB-INF/classes/db.properties");
        Properties properties = new Properties();
        properties.load(is);
        String username = properties.getProperty("username");
        String password = properties.getProperty("password");
        resp.getWriter().println(username+":"+password);

    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        doGet(req,resp);
    }
}

HttpServletResponse

web服务器接收到客户端的http请求，针对这个请求，分别创建一个代表请求的 HttpServletRequest
对象，代表响应的一个 HttpServletResponse;

• 如果要获取客户端请求过来的参数：找 HttpServletRequest
• 如果要给客户端响应一些信息：找 HttpServletResponse

简单分类

负责向浏览器发送数据的方法

ServletOutputStream getOutputStream() throws IOException;
PrintWriter getWriter() throws IOException;

负责向浏览器发送响应头的方法

void setCharacterEncoding(String var1);

void setContentLength(int var1);

void setContentLengthLong(long var1);

void setContentType(String var1);

void setDateHeader(String var1, long var2);

void addDateHeader(String var1, long var2);

void setHeader(String var1, String var2);

void addHeader(String var1, String var2);

void setIntHeader(String var1, int var2);

void addIntHeader(String var1, int var2);

响应的状态码

int SC_CONTINUE = 100;
int SC_SWITCHING_PROTOCOLS = 101;
int SC_OK = 200;
int SC_CREATED = 201;
int SC_ACCEPTED = 202;
int SC_NON_AUTHORITATIVE_INFORMATION = 203;
int SC_NO_CONTENT = 204;
int SC_RESET_CONTENT = 205;
int SC_PARTIAL_CONTENT = 206;
int SC_MULTIPLE_CHOICES = 300;
int SC_MOVED_PERMANENTLY = 301;
int SC_MOVED_TEMPORARILY = 302;
int SC_FOUND = 302;
int SC_SEE_OTHER = 303;
int SC_NOT_MODIFIED = 304;
int SC_USE_PROXY = 305;
int SC_TEMPORARY_REDIRECT = 307;
int SC_BAD_REQUEST = 400;
int SC_UNAUTHORIZED = 401;
int SC_PAYMENT_REQUIRED = 402;
int SC_FORBIDDEN = 403;
int SC_NOT_FOUND = 404;
int SC_METHOD_NOT_ALLOWED = 405;
int SC_NOT_ACCEPTABLE = 406;
int SC_PROXY_AUTHENTICATION_REQUIRED = 407;
int SC_REQUEST_TIMEOUT = 408;
int SC_CONFLICT = 409;
int SC_GONE = 410;
int SC_LENGTH_REQUIRED = 411;
int SC_PRECONDITION_FAILED = 412;
int SC_REQUEST_ENTITY_TOO_LARGE = 413;
int SC_REQUEST_URI_TOO_LONG = 414;
int SC_UNSUPPORTED_MEDIA_TYPE = 415;
int SC_REQUESTED_RANGE_NOT_SATISFIABLE = 416;
int SC_EXPECTATION_FAILED = 417;
int SC_INTERNAL_SERVER_ERROR = 500;
int SC_NOT_IMPLEMENTED = 501;
int SC_BAD_GATEWAY = 502;
int SC_SERVICE_UNAVAILABLE = 503;
int SC_GATEWAY_TIMEOUT = 504;
int SC_HTTP_VERSION_NOT_SUPPORTED = 505;

常见应用

向浏览器输出消息

下载文件

  1. 要获取下载文件的路径
  2. 下载的文件名是啥？
  3. 设置想办法让浏览器能够支持下载我们需要的东西
  4. 获取下载文件的输入流
  5. 创建缓冲区
  6. 获取OutputStream对象
  7. 将FileOutputStream流写入到buffer缓冲区
  8. 使用OutputStream将缓冲区中的数据输出到客户端！

@WebServlet("/file")
public class FileServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //1. 要获取下载文件的路径
        String realPath = this.getServletContext().getRealPath("/WEB-INF/classes/preview1.jpg");
        System.out.println(realPath);
        //2. 下载的文件名是啥？
        String fileName = realPath.substring(realPath.lastIndexOf("\\") + 1);
        //3. 设置想办法让浏览器能够支持下载我们需要的东西
        resp.setContentType("text/html;charset=UTF-8");
        resp.setHeader("Content-disposition","attachment;filename=" + URLEncoder.encode(fileName,"utf-8"));
        //4. 获取下载文件的输入流
        FileInputStream in = new FileInputStream(realPath);
        //5. 创建缓冲区
        int len=0;
        byte[] buffer = new byte[1024];
        //6. 获取OutputStream对象
        ServletOutputStream out = resp.getOutputStream();
        //7. 将FileOutputStream流写入到buffer缓冲区，使用OutputStream将缓冲区中的数据输出到客户端！
        while ((len=in.read(buffer))>0){
            out.write(buffer,0,len);
        }
        in.close();
        out.close();

    }

验证码功能

验证怎么来？

• 前端实现
• 后端实现，需要用到Java的图片类，生产一个图片

@WebServlet("/img")
public class ImageServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //让浏览器5秒自动刷新
        resp.setHeader("refresh", "5");
        //在内存中创建一个图片
        BufferedImage image = new BufferedImage(80, 20, BufferedImage.TYPE_INT_RGB);
        //得到图片
        Graphics2D g = (Graphics2D) image.getGraphics();
        //设置图片的背景颜色
        g.setColor(Color.WHITE);
        g.fillRect(0, 0, 80, 20);
        //给图片写数据
        g.setColor(Color.BLUE);
        g.setFont(new Font(null, Font.BOLD, 20));
        g.drawString(makeNum(), 0, 20);
        //告诉浏览器，这个请求用图片的方式打开
        resp.setHeader("content-type", "image/jpeg");
        //网站存在缓存，不让浏览器缓存
        resp.setDateHeader("expires", -1);
        resp.setHeader("Cache-Control", "no-cache");
        resp.setHeader("Pragma", "no-cache");
        //把图片写给浏览器
        ImageIO.write(image, "jpg", resp.getOutputStream());
    }

    private String makeNum() {
        Random random = new Random();
        String num = random.nextInt(9999999) + "";
        StringBuffer sb = new StringBuffer();
        for (int i = 0; i < 7 - num.length(); i++) {
            sb.append("0");
        }
        num = sb.toString() + num;
        return num;
    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        doGet(req, resp);
    }
}

实现重定向

B一个Web资源收到客户端A请求后，B他会通知A客户端去访可另外一个web资源C,这个过程叫重定向。
常见场景：

• 用户登录

  void sendRedirect(String var1) throws IOException;
  

测试：

@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
//        resp.setHeader("Location","./img");
//        resp.setStatus(302);
    resp.sendRedirect("./img");
}

面试题：请你聊聊重定向和转发的区别？
相同点

• 页面都会实现跳转

不同点

• 请求转发的时候，url不会产生变化
• 重定向的时候，url地址栏会发生变化

例子：

@WebServlet("/login")
public class RequestServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        String name = req.getParameter("name");
        String password = req.getParameter("password");
        //重定向时候一定要注意，路径问题，否则404
        resp.sendRedirect("welcome.jsp");
    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        doGet(req, resp);
    }
}

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html lang="en">
    <head>
        <meta charset="UTF-8">
        <meta name="viewport"
              content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
        <meta http-equiv="X-UA-Compatible" content="ie=edge">
        <title>Document</title>
    </head>
    <body>
        <form action="${pageContext.request.contextPath}/login" method="get">
            用户名：<input type="text" name="username">
            <br>
            密码：<input type="password" name="password">
            <br>
            <input type="submit" value="登录">
        </form>
    </body>
</html>

HttpServletRequest

HttpServletRequest代表客户端的请求，用户通过Http协议访问服务器，HTTP请求中的所有信息会被封装到 HttpServletRequest，通过这个HttpServletRequest的方法，获得客户端的所有信息。

获取前端传递的信息

请求转发

@WebServlet("/login")
public class LoginServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        req.setCharacterEncoding("utf-8");
        resp.setCharacterEncoding("utf-8");
        String name = req.getParameter("username");
        String password = req.getParameter("password");
        String[] hobbies = req.getParameterValues("hobby");
        System.out.println(name);
        System.out.println(password);
        System.out.println(Arrays.toString(hobbies));

        //通过请求转发
        //这里的/代表当前的web应用
        req.getRequestDispatcher("welcome.jsp").forward(req,resp);

    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        doGet(req, resp);
    }
}

面试题：请你聊聊重定向和转发的区别？
相同点

• 页面都会实现跳转

不同点

• 请求转发的时候，url不会产生变化 307
• 重定向的时候，url地址栏会发生变化 302