目录
RequestMappingInfo实体类(存放注解映射对应的一些信息)
spring核心配置文件spring-servlet.xml配置详情
BeanIdHandlerMapping(映射类的方式,id作为路径)
AnoHandlerMapping(映射方法的方式,注解value值作为路径)
BeanIdHandlerAdapter(id映射方式的适配器)
AnnoHandlerAdapter(注解映射方法方式的适配器)
springmvc的执行流程
- 1、用户请求发送到DispatcherServlet
- 2、DispatcherServlet根据请求去调用处理器映射器
- 3、处理器映射器根据请求url找到具体的处理器,生成处理器执行链HandlerExecutionChain(包括处理器对象和处理器拦截器,我们这里就不考虑拦截器了,有兴趣的可以自行扩展
- 4、将处理器执行链一并返回给DispatcherServlet
- 5、根据处理器Handler获取处理器适配器HandlerAdapter执行HandlerAdapter处理一系列的操作,如:参数封装,数据格式转换,数据验证等操作
- 6、执行处理器handler,即执行我们写的controller的方法
- 7,8、HandlerAdapter将Handler执行结果ModelAndView返回到DispatcherServlet
- 9、DispatcherServlet将ModelAndView传给视图解析器(ViewResolver)
- 10、ViewReslover解析后返回具体View
- 11、DispatcherServlet对View进行渲染视图
- 12、响应用户
- 注:8-12的解析器我们也没有考虑,我们只是实现一个简易版springmvc,实现核心的请求-调用这个过程,有兴趣可以自行扩展。
环境准备
- 使用maven构建项目 依赖包如下
<dependencies>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>3.1.0</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>5.0.5.RELEASE</version>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.74</version>
</dependency>
</dependencies>
- 项目结构如下
web.xml配置
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
version="4.0">
<servlet>
<servlet-name>DispatcherServlet</servlet-name>
<servlet-class>com.vuhen.springmvc.DispatcherServlet</servlet-class>
<!-- spring的核心配置类路径,用于初始化创建spring容器用的 -->
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:spring-servlet.xml</param-value>
</init-param>
</servlet>
<servlet-mapping>
<servlet-name>DispatcherServlet</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
</web-app>
控制层controller包
- 定义一个测试类1的test方法,用自定义的注解声明路径是/test 这个将作为以注解映射路径的方法方式访问
package com.vuhen.springmvc.controller;
import com.vuhen.springmvc.ano.RequestMapping;
import com.vuhen.springmvc.ano.RequestParam;
import org.springframework.stereotype.Controller;
@Controller
public class TestController {
@RequestMapping("/test")
public String test(){
System.out.println("--RequestMapping");
return "myspringmvc";
}
@RequestMapping("/test2")
public String test2(@RequestParam("name") String name,@RequestParam("age") Integer age){
System.out.println("姓名:"+name+",年龄:"+age);
return "哈哈";
}
}
- 定义一个测试类2的service方法,该类为servlet,在spring中定义为id="/helloServlet" 这个将作为以id映射路径的类方式访问
package com.vuhen.springmvc.controller;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
public class HelloServlet extends HttpServlet {
@Override
protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
System.out.println("helloServlet");
}
}
自定义RequestMapping注解 ano包
RequestMapping注解代码
package com.vuhen.springmvc.ano;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.METHOD)//这边我们不考虑注解可以用到类上,只考虑用到方法上
@Retention(RetentionPolicy.RUNTIME)//设置运行时产生
public @interface RequestMapping {
String value() default "";
}
RequestMappingInfo实体类(存放注解映射对应的一些信息)
package com.vuhen.springmvc.ano;
import java.lang.reflect.Method;
//实体类 存储用注解映射的方法、类、url具体信息
public class RequestMappingInfo {
private Method method;//注解value值所对应的方法
private Object object;//注解所对应的类
private String url;//注解所对应的url
public Method getMethod() {
return method;
}
public void setMethod(Method method) {
this.method = method;
}
public Object getObject() {
return object;
}
public void setObject(Object object) {
this.object = object;
}
public String getUrl() {
return url;
}
public void setUrl(String url) {
this.url = url;
}
}
RequestParam注解代码
package com.vuhen.springmvc.ano;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.PARAMETER)//作用域只在参数上
@Retention(RetentionPolicy.RUNTIME)//运行时产生
public @interface RequestParam {
String value() default "";
}
spring核心配置文件spring-servlet.xml配置详情
- 下面servlet类注入到spring容器直接配置id为要访问的路径,后续控制器代码会介绍
<?xml version="1.0" encoding="UTF-8" ?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd">
<!-- 扫描所有包下的类,将需要注入到spring容器的类全部注入到spring容器-->
<context:component-scan base-package="com.vuhen"/>
<!-- servler作为控制器-->
<bean id="/helloServlet" class="com.vuhen.springmvc.controller.HelloServlet"/>
</beans>
控制器handler包(核心)
HandlerMapping处理器映射接口
- 之所以要抽象出来,是因为我们有两种方式作为映射,一种是方法的方式,即我们定义的RequestMapping注解的value值;一种是类的方式,即HelloServlet用id作为映射的url方式
package com.vuhen.springmvc.handler;
import org.springframework.beans.factory.config.InstantiationAwareBeanPostProcessor;
public interface HandlerMapping extends InstantiationAwareBeanPostProcessor {//继承的是spring初始化的一个核心类
public Object getHandler(String url);
}
BeanIdHandlerMapping(映射类的方式,id作为路径)
package com.vuhen.springmvc.handler;
import org.springframework.beans.BeansException;
import org.springframework.stereotype.Component;
import java.util.HashMap;
import java.util.Map;
@Component
public class BeanIdHandlerMapping implements HandlerMapping {
static Map<String,Object> map = new HashMap<>();//存储每个url路径对应的bean对象
@Override
public Object getHandler(String url) {
return map.get(url);
}
//spring每实例化一个对象到容器后都会执行一次这个方法
@Override
/**
* @bean:实例化到容器的对象
* @beanName:实例化到容器的对象的id
*/
public boolean postProcessAfterInstantiation(Object bean, String beanName) throws BeansException {
//如果bean对象id是以/开头就说明是要映射地址 存到我们的map中
if (beanName.startsWith("/")) map.put(beanName,bean);
return true;//这个如果是false,那在这之后的类即使实现这个接口也不会再调用到这个方法了,类似于放行否
}
}
AnoHandlerMapping(映射方法的方式,注解value值作为路径)
package com.vuhen.springmvc.handler;
import com.vuhen.springmvc.ano.RequestMapping;
import com.vuhen.springmvc.ano.RequestMappingInfo;
import org.springframework.beans.BeansException;
import org.springframework.stereotype.Component;
import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.Map;
@Component
//处理RequestMapping注解的方法url映射
public class AnoHandlerMapping implements HandlerMapping{
static Map<String,Object> map = new HashMap<>();
@Override
public Object getHandler(String url) {
return map.get(url);
}
//spring每实例化一个对象到容器后都会执行一次这个方法
@Override
/**
* @bean:实例化到容器的对象
* @beanName:实例化到容器的对象的id
*/
public boolean postProcessAfterInstantiation(Object bean, String beanName) throws BeansException {
Method[] methods = bean.getClass().getDeclaredMethods();//获取该bean所有方法
//遍历该bean所有方法,将所有信息提取出来到RequestMappingInfo实体中,再存储该实体到map中
for (Method method : methods) {
RequestMappingInfo requestMappingInfo = createRequestMappingInfo(method, bean);
map.put(requestMappingInfo.getUrl(),requestMappingInfo);
}
return true;
}
/**
* 获取map要存储的具体对象
* @param method bean对象的方法
* @param bean bean对象
* @return 存储method,bean,url信息的实体类
*/
private RequestMappingInfo createRequestMappingInfo(Method method,Object bean){
RequestMappingInfo requestMappingInfo = new RequestMappingInfo();//实体类
//判断该方法是否有RequstMapping注解
if (method.isAnnotationPresent(RequestMapping.class)){
requestMappingInfo.setMethod(method);//存储有RequestMapping注解的Method
requestMappingInfo.setObject(bean);//存储有RequestMapping注解的bean
//存储url 就是RequestMapping注解的value值
requestMappingInfo.setUrl(method.getDeclaredAnnotation(RequestMapping.class).value());
}
return requestMappingInfo;//返回存储method,bean,url信息的实体类
}
}
HandlerAdapter处理器适配器接口
- 适配器之所以要抽象出来,跟映射器基本同理,因为我们有多个方式来处理
- 只有简单的两个方法,support用于判断我们是否有能够处理这种handler的适配器;handle就是具体执行控制层方法的一个调用,带有返回值
package com.vuhen.springmvc.handler;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public interface HandlerAdapter {
//判断是否是我们可使用的处理器
public boolean support(Object handler);
//处理器执行
public Object handle(HttpServletRequest request, HttpServletResponse response,Object handler) throws Exception;
}
BeanIdHandlerAdapter(id映射方式的适配器)
package com.vuhen.springmvc.handler;
import org.springframework.stereotype.Component;
import javax.servlet.Servlet;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
@Component
//beanId映射类的处理器适配器
public class BeanIdHandlerAdapter implements HandlerAdapter {
@Override
public boolean support(Object handler) {
return handler instanceof Servlet;
}
@Override
//servlet类里面只是简单的写了个service方法而已,直接调用就可以了
public Object handle(HttpServletRequest request, HttpServletResponse response,Object handler) throws ServletException, IOException {
Servlet servlet = (Servlet) handler;
servlet.service(request,response);
return null;
}
}
AnnoHandlerAdapter(注解映射方法方式的适配器)
- 这个可以说是整个springmvc请求-调用的核心
package com.vuhen.springmvc.handler;
import com.vuhen.springmvc.ano.RequestMappingInfo;
import com.vuhen.springmvc.ano.RequestParam;
import org.springframework.stereotype.Component;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import java.lang.reflect.Type;
import java.util.Map;
@Component
//注解映射方法方式的处理器适配器
public class AnnoHandlerAdapter implements HandlerAdapter {
@Override
public boolean support(Object handler) {
return handler instanceof RequestMappingInfo;
}
@Override
public Object handle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
RequestMappingInfo requestMappingInfo = (RequestMappingInfo) handler;//在该类已经确定是注解处理器了
Map<String, String[]> map = request.getParameterMap();//获取请求携带的所有参数
Method method = requestMappingInfo.getMethod();//获取要执行的方法
Parameter[] parameters = method.getParameters();//获取要执行的方法的所有参数
Object[] paramValues = new Object[parameters.length];//传入方法的参数
//遍历方法的所有参数上面的RequestParam注解的value值 目的是为了将请求的参数值存储到paramValues
for (int i = 0; i < parameters.length; i++) {
//请求携带的参数含有RequestParamvalue值 存储到paramValues中
if (map.containsKey(parameters[i].getDeclaredAnnotation(RequestParam.class).value())){
Type type = parameters[i].getParameterizedType();
//这里简单的判断一下要绑定的类型,暂时只写了两种类型
if (type.getTypeName().equals("java.lang.Integer")){
paramValues[i] =
Integer.parseInt(map.get(parameters[i].getDeclaredAnnotation(RequestParam.class).value())[0]);
}else if (type.getTypeName().equals("java.lang.String")){
paramValues[i] = map.get(parameters[i].getDeclaredAnnotation(RequestParam.class).value())[0];
}
}
}
//getObject就是该方法对应的类,之前在RequstInfo实体类中已经封装好了
return method.invoke(requestMappingInfo.getObject(),paramValues);//调用方法并返回方法返回值
}
}
DispatcherServlet类
package com.vuhen.springmvc;
import com.vuhen.springmvc.handler.HandlerAdapter;
import com.vuhen.springmvc.handler.HandlerMapping;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import javax.servlet.ServletConfig;
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.util.ArrayList;
import java.util.List;
import java.util.Map;
public class DispatcherServlet extends HttpServlet {
private List<HandlerMapping> handlerMappings;//存放spring中所有的HandlerMapping类
private List<HandlerAdapter> handlerAdapters;//存放spring中所有的HandlerAdapter类
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
Object handler = getHandler(req);
try {
//获取适配器
HandlerAdapter handlerAdapter = getHandlerAdapter(handler);
//调用适配器并拿到返回值 如果是注解上的方法有返回值,这步就会获取到返回值
Object result = handlerAdapter.handle(req, resp, handler);
System.out.println(result);//打印
} catch (Exception e) {
//异常信息,控制台打印提示
System.out.println("No mapping "+req.getRequestURI());
}
}
@Override
//tomcat第一次启动访问时初始化方法
public void init(ServletConfig config) throws ServletException {
super.init(config);
//初始化spring容器
ClassPathXmlApplicationContext app = new ClassPathXmlApplicationContext(config.getInitParameter("contextConfigLocation"));
//将spring容器中所有HandlerMapping类都取出来
Map<String, HandlerMapping> beansOfType = app.getBeansOfType(HandlerMapping.class);
handlerMappings = new ArrayList<>(beansOfType.values());
//将spring容器中所有HandlerAdapter类都取出来
Map<String, HandlerAdapter> beansOfType1 = app.getBeansOfType(HandlerAdapter.class);
handlerAdapters = new ArrayList<>(beansOfType1.values());
}
//根据request的url获取对应的处理器 此方法已经获取到控制器,但是还没有做适配,并不知道是id映射还是注解映射
private Object getHandler(HttpServletRequest request){
if (handlerMappings != null){
for (HandlerMapping handlerMapping : handlerMappings) {
Object handler = handlerMapping.getHandler(request.getRequestURI());
if (handler != null) return handler;
}
}
return null;
}
//获取处理器对应的适配器
private HandlerAdapter getHandlerAdapter(Object handler) throws Exception {
if (handlerAdapters != null){
for (HandlerAdapter handlerAdapter : handlerAdapters) {
//判断该处理器是我们可使用的处理器再返回该适配器
if(handlerAdapter.support(handler)) return handlerAdapter;
}
}
return null;
}
}
测试
id映射到servlet类测试
- 访问我们bean中配的id路径
- 控制台信息,可以看到确实没问题,我们打印了helloServlet,没有返回值
注解映射到方法测试
- 访问无参数的方法
- 控制台信息,打印--RequestMapping,返回值 myspringmvc
- 访问有参数的方法
- 控制台信息,打印信息正确,返回值正确
以上就是springmvc框架的请求-调用的一个简单实现了!springmvc请求-调用的核心基本就是这样了,读者可以根据上面这些去自行实现一个拦截器、解析器等功能出来!