手写实现迷你版Tomcat

手写实现迷你版Tomcat

名称： Minicat
Minicat要做的事：作为一个服务器软件提供服务，即我们可以通过浏览器客户端发送http请求，Minicat可以接收到请求进行处理，处理后的结果可以返回浏览器客户端。
1）提供服务，接收请求（Socket通信）
2）请求信息封装成Request对象（Response对象）
3）客户端请求资源，资源分为静态资源（html）和动态资源（Servlet）
4）资源返回给客户端浏览器
我们递进式完成以上需求，提出V1.0、 V2.0、 V3.0版本的需求
V1.0需求：浏览器请求http://localhost:8080,返回⼀个固定的字符串到⻚⾯"Hello Minicat!"
V2.0需求：封装Request和Response对象，返回html静态资源⽂件
V3.0需求：可以请求动态资源（Servlet）
完成上述三个版本后，我们的代码如下

• Bootstrap启动类

package com.jsc.minicat;

import org.dom4j.Document;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;

import javax.servlet.http.HttpServlet;
import java.io.InputStream;
import java.net.ServerSocket;
import java.net.Socket;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.*;

/**
 * Minicat的主类
 */
public class Bootstrap {

    /**定义socket监听的端⼝号*/
    private int port = 8080;
    public int getPort() {
        return port;
    }
    public void setPort(int port) {
        this.port = port;
    }

    private Map<String,HttpServlet> servletMap = new HashMap<>();

    /**
     * Minicat启动需要初始化展开的⼀些操作
     */
    public void start() throws Exception {
        // 加载解析相关的配置， web.xml
        loadServlet();
        // 定义⼀个线程池
        int corePoolSize = 10;
        int maximumPoolSize =50;
        long keepAliveTime = 100L;
        TimeUnit unit = TimeUnit.SECONDS;
        BlockingQueue<Runnable> workQueue = new ArrayBlockingQueue<>(50);
        ThreadFactory threadFactory = Executors.defaultThreadFactory();
        RejectedExecutionHandler handler = new
                ThreadPoolExecutor.AbortPolicy();ThreadPoolExecutor threadPoolExecutor = new ThreadPoolExecutor(
                corePoolSize,
                maximumPoolSize,
                keepAliveTime,
                unit,
                workQueue,
                threadFactory,
                handler
        );
        /*
        完成Minicat 1.0版本
        需求：浏览器请求http://localhost:8080,返回⼀个固定的字符串到⻚
        ⾯"Hello Minicat!"
        */
        ServerSocket serverSocket = new ServerSocket(port);
        System.out.println("=====>>>Minicat start on port： " + port);
        /*while(true) {
        Socket socket = serverSocket.accept();
        // 有了socket，接收到请求，获取输出流
        OutputStream outputStream = socket.getOutputStream();
        String data = "Hello Minicat!";
        String responseText =
        HttpProtocolUtil.getHttpHeader200(data.getBytes().length) + data;
        outputStream.write(responseText.getBytes());
        socket.close();
        }*/
        /**
         * 完成Minicat 2.0版本
         * 需求：封装Request和Response对象，返回html静态资源⽂件
         */
        /*while(true) {
        Socket socket = serverSocket.accept();
        InputStream inputStream = socket.getInputStream();
        // 封装Request对象和Response对象
        Request request = new Request(inputStream);
        Response response = new Response(socket.getOutputStream());
        response.outputHtml(request.getUrl());
        socket.close();}*/
        /**
         * 完成Minicat 3.0版本
         * 需求：可以请求动态资源（Servlet）
         */
        /*while(true) {
        Socket socket = serverSocket.accept();
        InputStream inputStream = socket.getInputStream();
        // 封装Request对象和Response对象
        Request request = new Request(inputStream);
        Response response = new Response(socket.getOutputStream());
        // 静态资源处理
        if(servletMap.get(request.getUrl()) == null) {
        response.outputHtml(request.getUrl());
        }else{
        // 动态资源servlet请求
        HttpServlet httpServlet =
        servletMap.get(request.getUrl());
        httpServlet.service(request,response);
        }
        socket.close();
        }
        */
        /*
        多线程改造（不使用线程池）
        */
        /*while(true) {
        Socket socket = serverSocket.accept();
        RequestProcessor requestProcessor = new
        RequestProcessor(socket,servletMap);
        requestProcessor.start();
        }*/
        System.out.println("=========>>>>>>使⽤线程池进⾏多线程改造");
        /*
        多线程改造（使用线程池）
        */
        while(true) {
            Socket socket = serverSocket.accept();
            RequestProcessor requestProcessor = new RequestProcessor(socket,servletMap);
            //requestProcessor.start();
            threadPoolExecutor.execute(requestProcessor);
        }
    }

    /**
     * 加载解析web.xml，初始化Servlet
     */
    private void loadServlet() {
        InputStream resourceAsStream =
                this.getClass().getClassLoader().getResourceAsStream("web.xml");
        SAXReader saxReader = new SAXReader();
        try {
            Document document = saxReader.read(resourceAsStream);
            Element rootElement = document.getRootElement();
            List<Element> selectNodes = rootElement.selectNodes("//servlet");
            for (int i = 0; i < selectNodes.size(); i++) {
                Element element = selectNodes.get(i);
                // <servlet-name>lagou</servlet-name>
                Element servletnameElement = (Element) element.selectSingleNode("servlet-name");
                String servletName = servletnameElement.getStringValue();
                // <servlet-class>server.LagouServlet</servlet-class>
                Element servletclassElement = (Element) element.selectSingleNode("servlet-class");
                String servletClass = servletclassElement.getStringValue();
                // 根据servlet-name的值找到url-pattern
                Element servletMapping = (Element) rootElement.selectSingleNode("/web-app/servlet-mapping[servlet-name='"
                        + servletName + "']");
                // /lagou
                String urlPattern = servletMapping.selectSingleNode("urlpattern").getStringValue();
                servletMap.put(urlPattern, (HttpServlet) Class.forName(servletClass).newInstance());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
    /**
     * Minicat 的程序启动⼊⼝
     * @param args
     */
    public static void main(String[] args) {
        Bootstrap bootstrap = new Bootstrap();
        try {
            // 启动Minicat
            bootstrap.start();
        }  catch (Exception e) {
            e.printStackTrace();
        }
    }
}

• Http协议⼯具类

package com.jsc.minicat;

/**
 * http协议⼯具类，主要是提供响应头信息，这⾥我们只提供200和404的情况
 */
public class HttpProtocolUtil {

    /**
     * 为响应码200提供请求头信息Request封装类
     * @return
     */
    public static String getHttpHeader200(long contentLength) {
        return "HTTP/1.1 200 OK \n" +
                "Content-Type: text/html \n" +
                "Content-Length: " + contentLength + " \n" +
                "\r\n";
    }
    /**
     * 为响应码404提供请求头信息(此处也包含了数据内容)
     * @return
     */
    public static String getHttpHeader404() {
        String str404 = "<h1>404 not found</h1>";
        return "HTTP/1.1 404 NOT Found \n" +
                "Content-Type: text/html \n" +
                "Content-Length: " + str404.getBytes().length + " \n" +
                "\r\n" + str404;
    }

}

• Request封装类

package com.jsc.minicat;

import java.io.IOException;
import java.io.InputStream;

/**
 * 把请求信息封装为Request对象（根据InputSteam输⼊流封装）
 */
public class Request {

    private String method; // 请求⽅式，⽐如GET/POST
    private String url; // 例如 /,/index.html
    private InputStream inputStream; // 输⼊流，其他属性从输⼊流中解析出来
    public String getMethod() {
        return method;
    }
    public void setMethod(String method) {
        this.method = method;
    }public String getUrl() {
        return url;
    }
    public void setUrl(String url) {
        this.url = url;
    }
    public InputStream getInputStream() {
        return inputStream;
    }
    public void setInputStream(InputStream inputStream) {
        this.inputStream = inputStream;
    }
    public Request() {
    }

    // 构造器，输⼊流传⼊
    public Request(InputStream inputStream) throws IOException {
        this.inputStream = inputStream;
        // 从输⼊流中获取请求信息
        int count = 0;
        while (count == 0) {
            count = inputStream.available();
        }
        byte[] bytes = new byte[count];
        inputStream.read(bytes);
        String inputStr = new String(bytes);
        // 获取第⼀⾏请求头信息
        String firstLineStr = inputStr.split("\\n")[0]; // GET / HTTP/1.1
        String[] strings = firstLineStr.split(" ");
        this.method = strings[0];
        this.url = strings[1];
        System.out.println("=====>>method:" + method);
        System.out.println("=====>>url:" + url);
    }

}

• Response封装类

package com.jsc.minicat;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.OutputStream;

/**
 * 封装Response对象，需要依赖于OutputStream
 *
 * 该对象需要提供核⼼⽅法，输出html
 */
public class Response {

    private OutputStream outputStream;
    public Response() {
    }
    public Response(OutputStream outputStream) {
        this.outputStream = outputStream;
    }
    // 使⽤输出流输出指定字符串
    public void output(String content) throws IOException {
        outputStream.write(content.getBytes());
    }
    /**
     *
     * @param path url，随后要根据url来获取到静态资源的绝对路径，进⼀步根据绝对路径
    读取该静态资源⽂件，最终通过
     * 输出流输出
     * /-----> classes
     */
    public void outputHtml(String path) throws IOException {
        // 获取静态资源⽂件的绝对路径
        String absoluteResourcePath =
                StaticResourceUtil.getAbsolutePath(path);
        // 输⼊静态资源⽂件
        File file = new File(absoluteResourcePath);
        if(file.exists() && file.isFile()) {
        // 读取静态资源⽂件，输出静态资源静态资源请求处理⼯具类
            StaticResourceUtil.outputStaticResource(new
                    FileInputStream(file),outputStream);
        }else{
        // 输出404
            output(HttpProtocolUtil.getHttpHeader404());
        }
    }

}

• 静态资源请求处理⼯具类

package com.jsc.minicat;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

public class StaticResourceUtil {

    /**
     * 获取静态资源⽂件的绝对路径
     * @param path
     * @return
     */
    public static String getAbsolutePath(String path) {
        String absolutePath =
                StaticResourceUtil.class.getResource("/").getPath();
        return absolutePath.replaceAll("\\\\","/") + path;
    }
    /**
     * 读取静态资源⽂件输⼊流，通过输出流输出
     */
    public static void outputStaticResource(InputStream inputStream,
                                            OutputStream outputStream) throws IOException {
        int count = 0;
        while(count == 0) {
            count = inputStream.available();
        }
        int resourceSize = count;
        // 输出http请求头,然后再输出具体内容动态资源请求S
        outputStream.write(HttpProtocolUtil.getHttpHeader200(resourceSize).getBytes());
        // 读取内容输出
        long written = 0 ;// 已经读取的内容⻓度
        int byteSize = 1024; // 计划每次缓冲的⻓度
        byte[] bytes = new byte[byteSize];
        while(written < resourceSize) {
            if(written + byteSize > resourceSize) { // 说明剩余未读取⼤⼩不⾜⼀个1024⻓度，那就按真实⻓度处理
                byteSize = (int) (resourceSize - written); // 剩余的⽂件内容⻓度
                bytes = new byte[byteSize];
            }
            inputStream.read(bytes);
            outputStream.write(bytes);
            outputStream.flush();
            written+=byteSize;
        }
    }

}

• 动态资源请求

• Servlet接⼝定义

package com.jsc.minicat;

public interface Servlet {

    void init() throws Exception;
    void destory() throws Exception;
    void service(Request request,Response response) throws Exception;

}

• HttpServlet抽象类定义

package com.jsc.minicat;

/**
 * @ClassName: HttpServlet
 * @Description: TODO
 * @Date: 2021/3/25 18:27
 * @Create by: shuiren
 */
public abstract class HttpServlet implements Servlet {

    public abstract void doGet(Request request,Response response);
    public abstract void doPost(Request request,Response response);
    @Override
    public void service(Request request, Response response) throws
            Exception {
        if("GET".equalsIgnoreCase(request.getMethod())) {
            doGet(request,response);
        }else{
            doPost(request,response);
        }
    }
}

• 业务类Servlet定义LagouServlet

package com.jsc.minicat;

import java.io.IOException;

public class LagouServlet extends HttpServlet {

    @Override
    public void doGet(Request request, Response response) {
        try {
            Thread.sleep(100000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        String content = "<h1>LagouServlet get</h1>";
        try {
            response.output((HttpProtocolUtil.getHttpHeader200(content.getBytes().length) + content));
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    @Override
    public void doPost(Request request, Response response) {
        String content = "<h1>LagouServlet post</h1>";
        try {
            response.output((HttpProtocolUtil.getHttpHeader200(content.getBytes().length) + content));
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    @Override
    public void init() throws Exception {
    }
    @Override
    public void destory() throws Exception {
    }

}

• 多线程改造封装的RequestProcessor类

package com.jsc.minicat;

import java.io.InputStream;
import java.net.Socket;
import java.util.Map;

public class RequestProcessor extends Thread {

    private Socket socket;
    private Map<String,HttpServlet> servletMap;
    public RequestProcessor(Socket socket, Map<String, HttpServlet> servletMap) {
        this.socket = socket;
        this.servletMap = servletMap;
    }
    @Override
    public void run() {
        try{
            InputStream inputStream = socket.getInputStream();
            // 封装Request对象和Response对象
            Request request = new Request(inputStream);
            Response response = new Response(socket.getOutputStream());
            // 静态资源处理第四部分 Tomcat 源码构建及核⼼流程源码剖析
            if(servletMap.get(request.getUrl()) == null) {
                response.outputHtml(request.getUrl());
            }else{
                // 动态资源servlet请求
                HttpServlet httpServlet = servletMap.get(request.getUrl());
                httpServlet.service(request,response);
            }
            socket.close();
        }catch (Exception e) {
            e.printStackTrace();
        }
    }

}