JavaWeb基础—Servlet

Servlet

1.Servlet简介

• Servlet就是Sun公司开发动态web的一门技术
• Sun公司在这些api中提供了一些接口：Servlet，如果想开发一个Servlet程序，需要以下两步
  • 编写一个类，实现Servlet接口
  • 把开发好的java类部署到web服务器中

把实现Servlet接口的java程序叫做Servlet

2.Hello Servlet

Servlet接口在sun公司有两个默认的实现类：HttpServlet、GenericServlet

1. 构建一个普通Maven项目，删掉里面的src，以后就在这个项目里面建立Module，这个空项目就是Maven的主工程

2. 在pom.xml文件中添加自己需要的依赖，依赖可以去https://mvnrepository.com/自行下载

3. 在项目中创建子模块

创建完之后：

对Maven父子工程的理解：
父项目中会有：

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

子项目中会有：

<parent> 
<artifactId>javaweb02</artifactId>
<groupId>org.example</groupId>
<version>1.0-SNAPSHOT</version>
</parent>

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

4. Maven环境优化
   1. 修改web.xml文件为最新，找到tomcat目录，找到webapp，点击进入找到ROOT，再点击WEB-INF，将里面web.xml文件复制到项目的web.xml文件上即可。
   2. 将maven结构搭建完整
5. 编写一个Servlet
   1. 编写一个普通类
   2. 实现servlet接口，直接继承HttpServlet

import javax.servlet.ServletException
;import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;
public class HelloServlet extends HttpServlet {        
//由于get或者post只是请求实现不同的方式，可以互相调用，业务逻辑一样    
@Override   
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {                PrintWriter writer = resp.getWriter();
//响应流                
writer.print("hello servlet");          
}    
@Override    
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {        
doGet(req, resp);  
}
}

6. 编写Servlet的映射

为什么要映射：因为我们写的java程序，要通过浏览器访问，而浏览器需要连接web服务器，所以我们要在web服务器中注册我们写的servlet，还需要给他一个浏览器能够访问的路径。

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

7. 添加Tomcat

添加tomcat时要检查tomcat配置如下，还要再Deployment是添加servlet02-war，要是有新的web项目要重新添加.war的文件到Deployment：

8. 启动测试
   测试完后会跳转到
   

这个页面则是Tomcat中所设置的路径打开的页面：

3.Servlet原理

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

主要流程是浏览器发送http请给web服务器，服务器再用请求调用servlet，servlet通过我们自己编写的类，处理请求，最后给出响应信息，再把信息反馈给Response，web服务器再从Response中读取响应信息。

4.Mapping

所注册的servlet如下：

  <servlet>
    <servlet-name>hello</servlet-name>
    <servlet-class>servletcollection.HelloServlet</servlet-class>
  </servlet>

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>

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>*.xiaopan</url-pattern>
</servlet-mapping>

意思是只要后缀是.xiaopan即可访问（/*.xiaopan这样是不行的，会报错）：

注意：*前面不能加项目映射的路径/

5. 默认的请求路径

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

使用默认的话就没有首页的Hello World！页面了，直接显示hello servlet。

6. 优先级问题

编写默认路径的servlet为

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;
public class ErrorServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        resp.setContentType("text/html");
        resp.setCharacterEncoding("utf-8");//设置编码格式
        PrintWriter writer = resp.getWriter();
        writer.print("<h1>404<h1>");//因为上面设置setContentType，所以可以直接输入html代码
    }
    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        doGet(req, resp);
    }
}

再在配置文件中配置servlet：

<!--注册HelloServlet的servlet-->
  <servlet>
    <servlet-name>hello</servlet-name>
    <servlet-class>servletcollection.HelloServlet</servlet-class>
  </servlet>

  <servlet-mapping>
    <servlet-name>hello</servlet-name>
    <url-pattern>/hello</url-pattern>
  </servlet-mapping>
<!--注册ErrorServlet的servlet-->
  <servlet>
    <servlet-name>error</servlet-name>
    <servlet-class>servletcollection.ErrorServlet</servlet-class>
  </servlet>

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

则当测试的时候，因为/*默认路径为ErrorServlet，所以会显示ErrorServlet的页面

当输入HelloServlet的路径时，还是会响应出HelloServlet的页面

说明：指定固有路径的映射路径优先级最高，如果找不到就会走默认的请求路径。

5.ServletContext

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

5.1共享数据

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

例子如下：

//数据类
public class Data extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        ServletContext servletContext = this.getServletContext();
        String name = "xiaopan";//假设为数据
        servletContext.setAttribute("name",name);//将数据保存到ServletContext中，名为name，值为name

    }
}

先后编写好数据类，和获取数据类

//获取数据类
public class reader extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        ServletContext servletContext = this.getServletContext();
        String name = (String) servletContext.getAttribute("name");//获取数据

        resp.setContentType("text/html");
        resp.setCharacterEncoding("utf-8");
        resp.getWriter().print("我的名字是"+name);
    }
}

注册Servlet：

<!--注册reader的servlet-->
  <servlet>
    <servlet-name>reader</servlet-name>
    <servlet-class>servletcollection.reader</servlet-class>
  </servlet>

  <servlet-mapping>
    <servlet-name>reader</servlet-name>
    <url-pattern>/reader</url-pattern>
  </servlet-mapping>
<!--注册Data的servlet-->
  <servlet>
    <servlet-name>Data</servlet-name>
    <servlet-class>servletcollection.Data</servlet-class>
  </servlet>

  <servlet-mapping>
    <servlet-name>Data</servlet-name>
    <url-pattern>/getdata</url-pattern>
  </servlet-mapping>

启动测试，发现当首次访问路径/reader，是没有数据的：

要先访问/data之后，再访问reader才会得到数据：

5.2获取初始化参数

先在web.xml文件配置参数：

<!--  配置一些web应用的初始化参数-->
  <context-param>
    <param-name>url</param-name>
    <param-value>jdbc:mysql://localhost:3306/mybatis</param-value>
  </context-param>

再在doGet()方法里面获取配置信息：

ServletContext servletContext = this.getServletContext();
String url = servletContext.getInitParameter("url");
resp.getWriter().print(url);//打印获取到的配置信息

5.3请求转发

@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
    ServletContext servletContext = this.getServletContext();
    RequestDispatcher requestDispatcher = servletContext.getRequestDispatcher("/gp");//转发的请求路径
    requestDispatcher.forward(req,resp);//调用forward实现请求转发
}

设置当前java文件的servlet映射：

<servlet>
  <servlet-name>sd2</servlet-name>
  <servlet-class>servletcollection.servletdemo02</servlet-class>
</servlet>
<servlet-mapping>
  <servlet-name>sd2</servlet-name>
  <url-pattern>/sd2</url-pattern>
</servlet-mapping>

则当运行的时候，通过/sd2进入当前java请求的页面的时候，请求会转发到/gp路径下的页面，而页面的路径是不变的。

拓展：如果是重定向的话，则页面的路径也会改变。

5.4读取资源

Properties

• 在java目录下新建properties资源文件

  直接在java目录下创建资源文件在重新启动maven后，target中的classes文件里面没有该资源文件

  解决方法：在该web项目的pom.xml中配置：

  <!--在build中配置resources，来防止资源导出失败-->
  <build>
      <resources>
        <resource>
          <directory>src/main/java</directory>
          <includes>
            <include>**/*.properties</include>
            <include>**/*.xml</include>
          </includes>
          <filtering>true</filtering>
        </resource>
      </resources>
    </build>
  

• 在resources目录下新建properties文件

  username=root
  password=123456
  

  读取资源步骤如下：

  1. 然后需要在maven项目下的生命周期将maven先clean，再重新install，资源文件就会被打包在target的classes目录下，将这个路径称为classpath

  2. 读取文件的思路：

@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
    InputStream resourceAsStream = this.getServletContext().getResourceAsStream("/WEB-INF/classes/db.properties");//获取资源的路径
    Properties properties = new Properties();
    properties.load(resourceAsStream);//用输入流下载资源
    //获取资源
    String user = properties.getProperty("username");
    String pwd = properties.getProperty("password");
    //打印资源
    resp.getWriter().print(user +":"+ pwd);
}

注意：资源路径"/WEB-INF/classes"是固定的，后面才是资源在classes下的自己的路径

3. 注册servlet，测试

得到结果

6.HttpServletResponse

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

• 如果要获取客户端请求过来的参数：找HttpServletRequest

• 如果要给客户端一些响应信息：找HttpServletResponse

6.1简单分类

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

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;

每个数字都代表一种状态。

6.2下载文件

步骤如下：

1. 要获取下载文件的路径
2. 下载的文件名是什么
3. 想办法让浏览器能够支持**(Content-Disposition)**下载我们需要的东西（这个可以上百度查web下载文件设置的头信息）
4. 获取下载文件的输入流
5. 创建缓冲区
6. 获取OutputStream对象
7. 将FileOutStream流写入到buffer缓冲区
8. 使用OutputStream将缓冲区的数据输出到客户端

具体实现如下：

@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
//1. 要获取下载文件的路径
    String realPath ="D:\\Idea\\idea2021\\workplace\\javaweb02\\response\\target\\classes\\test.PNG";//可以直接在target目录下找到图片文件然后右键复制绝对路径
    System.out.println("文件的下载路径是：" + realPath);
//2. 下载的文件名是什么
    String filename = realPath.substring(realPath.lastIndexOf("\\") + 1);
//3. 想办法让浏览器能够支持(Content-Disposition)下载我们需要的东西
    //resp.setHeader("Content-Disposition","attchment;filename="+filename);
    //当文件名字是中文时,要使用下面这种方法，否则乱码
    resp.setHeader("Content-Disposition","attchment;filename="+ URLEncoder.encode(filename,"utf-8"));
//4. 获取下载文件的输入流
    FileInputStream fileInputStream = new FileInputStream(realPath);
//5. 创建缓冲区
    int len = 0;
    byte[] buffer = new byte[1024];
//6. 获取OutputStream对象
    ServletOutputStream outputStream = resp.getOutputStream();
//7. 将FileOutStream流写入到buffer缓冲区,
//8. 使用OutputStream将缓冲区的数据输出到客户端
    while((len = fileInputStream.read(buffer)) > 0){
        outputStream.write(buffer,0,len);
    }
//将流关闭
    fileInputStream.close();
    outputStream.close();

}

启动Tomcat后，输入路径/down，跳转成功后就自动将图片下载了

6.3验证码功能

如何通过web实现一个简单的验证码：

每3秒里面的数字就会变化一次。

基本步骤如下：

1. 先设置浏览器，通过setHeader()让浏览器3秒刷新一次
2. 再在内存中创建一个图片，并且设置它的长度和高度
3. 让图片获得一支笔，可以在图片上画画
4. 注意：每次对笔进行不同的画画时要重新设置笔的颜色和字体
5. 通过响应来设置让浏览器将这个请求以图片的形式打开
6. 将图片写给浏览器，使用到的是ImageIO类中的write()方法

@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
    //1.如何让浏览器3秒刷新一次
    resp.setHeader("refresh","3");
    //2.在内存中创建一个图片
    BufferedImage image = new BufferedImage(80, 20, BufferedImage.TYPE_INT_BGR);
    //3.得到图片
    Graphics2D g = (Graphics2D)image.getGraphics();//相当于一支笔
    //4.设置图片的背景颜色
    g.setColor(Color.orange);
    g.fillRect(0,0,80,20);//颜色填充
    //给图片写数据，要记得给画笔变颜色
    g.setColor(Color.blue);
    g.setFont(new Font(null,Font.BOLD,20));
    g.drawString(makeNum(),0,20);
    //5.告诉浏览器这个请求用图片的形式打开
    //resp.setContentType("image/jepg");如果是这种方式的话，打开的时候浏览器就自动下载图片了，所以要换成下面的方式
    resp.setContentType("image/webp");
    //网站存在缓存,不让浏览器缓存（还不用掌握）
    //这些可以上百度查不用自己记
    resp.setDateHeader("expires",-1);
    resp.setHeader("Cache-Control","no-cache");
    resp.setHeader("Pragma","no-cache");

    //6.把图片写给浏览器
    ImageIO.write(image,"jpg",resp.getOutputStream());

}

//生成随机数字
private String makeNum(){
    Random random = new Random();
    String num = random.nextInt(9999999)+"";
    StringBuffer sb = new StringBuffer();
    //下面填充0是为了保证输出的全都是7位数的验证码
    for(int i = 0;i < 7-num.length();i++){
        sb.append("0");
    }
    String s = sb.toString() + num;
    return s;
}

6.4实现重定向

一个web资源B收到客户端A请求后，他会通知客户端访问另外一个web资源C，这个过程叫做重定向

常用场景：用户登录…

void sendRedirect(String var1) throws IOException;

测试：

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //resp.setHeader("Loaction","image");
        //resp.setStatus(302);
        //输入的是servlet的名字，会自动跳转到该servlet,也可以输入Tomcat里部署的上下文再加servlet名字来访问
        resp.sendRedirect("image");
        //resp.sendRedirect("/response_war_exploded/image");
    }

Tomcat中部署的上下文：

重定向和请求转发的异同：

相同点：

• 页面都会跳转

不同点：

• 请求转发的时候，url不会改变
• 重定向的时候，url会改变

7.HttpServletRequest

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

1.获取前端传递的参数

2.请求转发

测试;

@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
    //解决数据乱码问题
    req.setCharacterEncoding("utf-8");
    resp.setCharacterEncoding("utf-8");

    String username = req.getParameter("username");
    String password = req.getParameter("password");
    String[] hobbys = req.getParameterValues("hobbys");

    System.out.println("=================================");
    System.out.println(username);
    System.out.println(password);
    System.out.println(Arrays.toString(hobbys));
    System.out.println("=================================");

    //通过请求转发
    //这里的/就代表当前web应用，req.getContextPath()就相当于是tomcat里面设置的Deployment里面的app context
    req.getRequestDispatcher("/success.jsp").forward(req,resp);
}

index.jsp下：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>

<h1>登录</h1>

<div style="text-align: center">
    <%--以post方式提交表单，提交到我们的login请求--%>
    <form action="${pageContext.request.contextPath}/login" method="post">
        用户名：<input type="text" name="username"><br>
        密码：<input type="password" name="password"><br>
        爱好：
        <input type="checkbox" name="hobbys" value="篮球">篮球
        <input type="checkbox" name="hobbys" value="代码">代码
        <input type="checkbox" name="hobbys" value="唱歌">唱歌
        <input type="checkbox" name="hobbys" value="电影">电影

        <br>
        <input type="submit">

    </form>
</div>
</body>
</html>

通过运行tomcat，会弹出页面

提交表单之后，在idea控制台会输出获取表单的数据：