【仿写spring之mvc篇】一、通过反射读取带有@RequestMapping与@Controller注解的类并模拟请求路径调用方法

已于 2023-09-01 15:47:06 修改
阅读量1.1k 收藏 3
点赞数 1
分类专栏： 源码仿写 文章标签： spring 服务器 java 反射 ssm框架
于 2023-07-22 21:20:08 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_51383106/article/details/131870520
版权

目录

简介

通过反射读取带有@RequestMapping与@Controller注解的类并模拟请求路径调用方法

思路

首先拆分问题，我们在问题中有几个需求：

  1. 自定义注解@RequestMapping、@Controller
  2. 扫描文件夹
  3. 通过反射读取类信息找到有@Controller和@RequestMapping注解的类
  4. 通过new Instance()获取对象
  5. 通过invoke调用方法

进一步思考：

1、@RequestMapping可以用在哪些地方？是否支持运行时检测？
类、方法
支持运行时检测

2、反射读取类信息有三种方式：

  • 类名.class
  • 对象.getClass()
  • Class.forName()

该选用哪一种呢？

实际上在编写框架的时候，我们并不知道使用者会定义哪些类，所以我们应该通过Class.forName()来获取类信息。
而Class.forName()传递的参数是类的全限定名即：包名+类名（com.ez4sterben.entity.Student）
随之第五个需求产生，编写一个根据路径转化为全限定名的方法。

实践

一、自定义注解@RequestMapping，@Controller

根据前一部分的分析，自定义注解

package com.spring.annotation;

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

/**
 * 控制器
 *
 * @author ez4sterben
 * @date 2023/07/22
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Controller {
}

package com.spring.annotation;

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

/**
 * 请求映射
 *
 * @author ez4sterben
 * @date 2023/07/22
 */
@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface RequestMapping {

    String value() default "";
}
二、路径转全限定名方法
    /**
     * 获取java路径
     *
     * @param file 文件
     * @return {@link String}
     */
    private static String getJavaPath(File file) {
        return file.toString().replace("\\",".").split("src.")[1].replace(".java","");
    }
三、扫描文件夹

我们通过递归实现扫描文件夹，获取其中以.java结尾的文件，调用刚才编写的方法存入List中

	public static String JAVA = ".java";
	public static List<String> javaFiles = new ArrayList<>();
	/**
     * 获取所有文件
     *
     * @param file 文件
     */
    public static void getAllFile(File file){
        if (file.isFile()){
            if (file.toString().endsWith(JAVA)) {
                String javaPath = getJavaPath(file);
                javaFiles.add(javaPath);
            }
        }
        if (file.exists() && file.isDirectory()) {
            File[] files = file.listFiles();
            if (files != null) {
                for (File file1 : files) {
                    getAllFile(file1);
                }
            }
        }
    }

文件扫描相关的工作到这里就完成了，完整代码如下：

package com.spring.utils;

import java.io.File;
import java.util.ArrayList;
import java.util.List;

/**
 * 文件扫描
 *
 * @author ez4sterben
 * @date 2023/07/22
 */
public class FileScannerUtil {

    public static List<String> javaFiles = new ArrayList<>();
    public static String JAVA = ".java";


    /**
     * 得到所有java文件
     *
     * @param path 路径
     * @return {@link List}<{@link String}>
     */
    public static List<String> getAllJavaFile(String path){
        getAllFile(new File(path));
        return javaFiles;
    }

    /**
     * 获取所有文件
     *
     * @param file 文件
     */
    public static void getAllFile(File file){
        if (file.isFile()){
            if (file.toString().endsWith(JAVA)) {
                String javaPath = getJavaPath(file);
                javaFiles.add(javaPath);
            }
        }
        if (file.exists() && file.isDirectory()) {
            File[] files = file.listFiles();
            if (files != null) {
                for (File file1 : files) {
                    getAllFile(file1);
                }
            }
        }
    }

    /**
     * 获取java路径
     *
     * @param file 文件
     * @return {@link String}
     */
    private static String getJavaPath(File file) {
        return file.toString().replace("\\",".").split("src.")[1].replace(".java","");
    }

}
四、通过反射来寻找有@RequestMapping以及@Controller的类

从这里开始我们就需要一个测试类来调用方法了，这里我将测试类的代码全部展示出来。

package com.spring;

import com.spring.utils.BeanUtil;
import com.spring.utils.FileScannerUtil;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.List;
import java.util.Map;

/**
 * 测试
 *
 * @author ez4sterben
 * @date 2023/07/22
 */
public class Test {

    public static String PATH = "F:\\projects\\JavaSEContainer\\sterben\\src\\com\\spring\\controller";
    public static String REQUEST_PATH = "/test/index";


    public static void main(String[] args) {
        // 模拟启动tomcat
        init();
        // 模拟接收请求
        request(REQUEST_PATH);
    }

    /**
     * 初始化
     */
    public static void init(){
        List<String> files = FileScannerUtil.getAllJavaFile(PATH);
        try {
            for (String file : files) {
                if (BeanUtil.isControllerAndRequestMapping(file)){
                    BeanUtil.createBean(file);
                }
            }
        } catch (ClassNotFoundException | InstantiationException | IllegalAccessException e) {
            e.printStackTrace();
        }
    }

    /**
     * 请求
     *
     * @param url url
     */
    public static void request(String url){
        String[] urls = url.split("/");
        String controllerName = urls[1];
        String methodName = urls[2];
        Object bean = BeanUtil.getBean("/" + controllerName);
        try {
            Map<String, Method> beanMethods = BeanUtil.getBeanMethods(bean.getClass());
            Method method = beanMethods.get("/" + methodName);
            Object invoke = method.invoke(bean);
            System.out.println(invoke);
        } catch (ClassNotFoundException | IllegalAccessException | InvocationTargetException e) {
            e.printStackTrace();
        }
    }
}

判断是否有Controller以及RequestMapping注解，这里通过测试类中的init方法调用，遍历我们扫描文件夹得到的List判断每个全限定名是否有这两个注解。

    /**
     * 控制器和请求映射
     *
     * @param name 全限定名
     * @return {@link Boolean}
     * @throws ClassNotFoundException 类没有发现异常
     */
    public static Boolean isControllerAndRequestMapping(String name) throws ClassNotFoundException {
        Class<?> clazz = Class.forName(name);
        Controller controller = clazz.getAnnotation(Controller.class);
        RequestMapping requestMapping = clazz.getAnnotation(RequestMapping.class);
        if (controller != null && requestMapping != null){
            return Boolean.TRUE;
        }
        return Boolean.FALSE;
    }
五、获取对象实例

这部分代码在测试类中的init方法里面调用，创建一个bean并且存入Map中。key是annotation中的value即我们传入的请求路径，value是实例。

    public static Map<String,Object> beanMap = new HashMap<>();

    /**
     * 创建bean
     *
     * @param name 名字
     * @throws ClassNotFoundException 类没有发现异常
     * @throws InstantiationException 实例化异常
     * @throws IllegalAccessException 非法访问异常
     */
    public static void createBean(String name) throws ClassNotFoundException, InstantiationException, IllegalAccessException {
        Class<?> clazz = Class.forName(name);
        RequestMapping annotation = clazz.getAnnotation(RequestMapping.class);
        Object instance = clazz.newInstance();
        beanMap.put(annotation.value(), instance);
    }
六、通过invoke调用方法

在日常开发中我们都是通过请求来调用方法的，那么理所当然，我们需要列出controller中的所有method并匹配执行。（注意：这里博主写的不够好，这个方法得到的结果也应该保存在一个Map中管理，可以自行优化）

	/**
     * get bean方法
     *
     * @param clazz clazz
     * @return {@link Map}<{@link String},{@link Method}>
     * @throws ClassNotFoundException 类没有发现异常
     */
    public static Map<String,Method> getBeanMethods(Class<?> clazz) throws ClassNotFoundException {
        Map<String,Method> methodMap = new HashMap<>();
        Method[] declaredMethods = clazz.getDeclaredMethods();
        for (Method declaredMethod : declaredMethods) {
            declaredMethod.setAccessible(true);
            RequestMapping annotation = declaredMethod.getAnnotation(RequestMapping.class);
            if (annotation != null){
                methodMap.put(annotation.value(), declaredMethod);
            }
        }
        return methodMap;
    }

调用详见测试类的request方法。

BeanUtil详细代码：

package com.spring.utils;

import com.spring.annotation.Controller;
import com.spring.annotation.RequestMapping;

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.Map;

/**
 * javaBean工具类
 *
 * @author ez4sterben
 * @date 2023/07/22
 */
public class BeanUtil {

    public static Map<String,Object> beanMap = new HashMap<>();

    /**
     * 创建bean
     *
     * @param name 名字
     * @throws ClassNotFoundException 类没有发现异常
     * @throws InstantiationException 实例化异常
     * @throws IllegalAccessException 非法访问异常
     */
    public static void createBean(String name) throws ClassNotFoundException, InstantiationException, IllegalAccessException {
        Class<?> clazz = Class.forName(name);
        RequestMapping annotation = clazz.getAnnotation(RequestMapping.class);
        Object instance = clazz.newInstance();
        beanMap.put(annotation.value(), instance);
    }


    /**
     * get bean方法
     *
     * @param clazz clazz
     * @return {@link Map}<{@link String},{@link Method}>
     * @throws ClassNotFoundException 类没有发现异常
     */
    public static Map<String,Method> getBeanMethods(Class<?> clazz) throws ClassNotFoundException {
        Map<String,Method> methodMap = new HashMap<>();
        Method[] declaredMethods = clazz.getDeclaredMethods();
        for (Method declaredMethod : declaredMethods) {
            declaredMethod.setAccessible(true);
            RequestMapping annotation = declaredMethod.getAnnotation(RequestMapping.class);
            if (annotation != null){
                methodMap.put(annotation.value(), declaredMethod);
            }
        }
        return methodMap;
    }

    /**
     * get bean
     *
     * @param name 名字
     * @return {@link Object}
     */
    public static Object getBean(String name){
        return beanMap.get(name);
    }

    /**
     * 控制器和请求映射
     *
     * @param name 名字
     * @return {@link Boolean}
     * @throws ClassNotFoundException 类没有发现异常
     */
    public static Boolean isControllerAndRequestMapping(String name) throws ClassNotFoundException {
        Class<?> clazz = Class.forName(name);
        Controller controller = clazz.getAnnotation(Controller.class);
        RequestMapping requestMapping = clazz.getAnnotation(RequestMapping.class);
        if (controller != null && requestMapping != null){
            return Boolean.TRUE;
        }
        return Boolean.FALSE;
    }
}

文件结构以及测试结果

1、文件结构

在这里插入图片描述

2、TestController
package com.spring.controller;

import com.spring.annotation.Controller;
import com.spring.annotation.RequestMapping;

/**
 * 测试控制器
 *
 * @author ez4sterben
 * @date 2023/07/22
 */
@RequestMapping("/test")
@Controller
public class TestController {

    @RequestMapping("/index")
    public String index(){
        System.out.println("/test/index");
        return "执行完了";
    }
}
3、测试结果

在这里插入图片描述

Ez4Sterben
关注
专栏目录
初学Spring-MVC，@RequestMapping多级路径访问成功，跳转jsp页面404
weixin_49254857的博客
11-23 1422
Controller @Controller @RequestMapping("/hello") public class HelloController { @RequestMapping("/01") public String method01(Model model){ //Service处理业务 String result="Hello SpringMVC (-v-)"; //向模型中传入数据,用于传入前端进行页面渲染 .
SpringMVC详解一、@RequestMapping注解与Controller接收参数
热门推荐
mxcsdn的博客
06-17 2万+
1、SpringMVC的概述2、SpringMVC的核心DispatcherServlet程序3、SpringMVC的示例程序4、视图解析器5、@RequestMapping注解详解标注在方法上6、Controller中如何接收请求参数1、SpringMVC的概述Spring MVC框架是一个开源的Java平台，为开发强大的基于JavaWeb应用程序提供全面的基础架构支持非常容易和非常快速。Spr...
自己手写的mvc,仿照Springmvc
01-25
自己手写的mvc,适用于传json字符串参数，普通表单参数，jsonObject
仿SpringMVC
Jeff的专栏
02-26 356
最近在看Spring的源码，开始的时候看的没有头绪，自己大脑都是乱麻；自己就在网上找资料，自己慢慢的看，到现在只是刚刚开始，把自己总结的SpringMVC的个人心得分享个大家，很多都是在网上找的资料，现在开始....首先展示目录结构：现在开始正文：创建注解，可以仿照Spring的源码中的注解@Controllerpackage com.stone.annotation; import java....
仿写springmvc(反射)
m0_56033865的博客
01-17 224
Main.class 定义了程序启动的入口，在实际中由tomcat启动main方法 public class Main { static { String path = Main.class.getResource("").getPath();//获取类加载的根路径 String packageName = Main.class.getPackage().getName();//返回包名 HeaboyMvc.scanner(path,packageNa
Spring AOP 和 拦截器 获取类上与方法上的注解
TechnicianWang的博客
06-17 8003
在做一个跨过目标注解的鉴权功能时，想到了AOP与拦截器两种方式，其中 @HasPermission 是我自定义的注解，以下分别为AOP与拦截器获取访问目标类与方法上的注解的方法。由于我的系统在拦截器上配置了拦截过则，所以我选的是拦截器的方式，读者可根据自己的需求来。先通过ProceedingJoinPoint对象的 joinPoint.getSignature()方法获取到 Signature 的对象并强制类型转换为一个MethodSignature对象，通过 signature.getClass()方法获
自己动手模仿 springmvc 写一个 mvc框架
Hoshea_chx的博客
09-21 516
spring的知识那么多，看源码也不知从何看起，那应该怎么学呢？我觉得，完整的spring我们写不出来，但是一个简单的，我们还是可以实现的。自己动手去实现一个简单的spring，是学习它的最好的方式。 bfmvc模仿springmvc的轻量级web框架，适合学习和搭建小型web项目使用，持续更新项目地址：https://github.com/CFshuming/bfmvc感兴趣的记得star哟~目录
Spring MVC温故而知新系列教程之请求映射RequestMapping注解
08-27
在Spring MVC框架中，`@RequestMapping`注解是核心组件之一，它负责将HTTP请求与控制器类的处理方法进行映射，从而实现请求分发。该注解可以应用于类级别和方法级别，提供了多种属性来精细控制请求的匹配规则。 ###...
Spring MVC之@RequestMapping详解
09-21
《Spring MVC之@RequestMapping详解》 在Java Web开发中，Spring MVC框架因其强大的功能和灵活性而备受青睐。在处理HTTP请求时，@RequestMapping注解扮演着至关重要的角色，它负责将客户端的请求映射到控制器中的...
SpringMVC中 @RequestMapping注解的使用 与 请求处理方法的参数
norang的博客
07-11 1725
十、@RequestMapping注解的使用 1、主要作用，把请求的URL映射到一个处理器的方法上，RequestMappingHandle处理器映射器针对该注解来完成URL到处理器方法的映射，它返回的是方法对象，因此对应的处理器适配器就知道去执行那个方法。 2、在方法上使用该注解，处理器适配器不需要按照某种接口类型去执行接口的方法，因此使用该注解给编程带来了灵活性。 3、该注解的主要属性取值： （1）value：映射URL，不需要带上主机名，接口和项目名，它是从项目名（/）开始表示的。 （2）method
Spring启动后获取所有拥有特定注解的Bean实例代码
08-28
主要介绍了Spring启动后获取所有拥有特定注解的Bean实例代码，分享了相关代码示例，小编觉得还是挺不错的，具有一定借鉴价值，需要的朋友可以参考下
获取RequestMapping所有的方法和路径|SpringMvc的Controller
05-16
通过编译文件的class路径，反射得到Class，获取RequestMapping对应注解和value路径
仿写SpringMvc底层源码
qq_31859365的博客
04-07 1215
     一直没有记笔记的习惯，就在此时，决定将自己每一次进步都记录下来。经过几次国内大公司面试。目前而言：对java的理解是停留在运用框架和中间件的层次上，对于底层原理并没有深刻去理解。所以让我决定重新学习java的想法。花了一点时间，将springMvc从底层进行了简单分析。从web.xml，配置加载，常用注解，我们将底层重新进行简单的开发，目的了解spring的底层思想。首先从几个题目出发：...
springMVC-高仿手写springMVC框架
weixin_44044929的博客
03-04 411
思路整理 SpringMVC原理简单回顾 核心：靠的就是DispatcherServlet拦截客户端所有请求实现转发到具体的请求方法执行。 SpringMVC思路: 控制层和 url 映射关联定义好存放到Map集合中 肯定在项目启动时候 1.扫包获取cLass中的方法有加上RequestMapping 如果有有该注解的话存放到map集合 2.key: urL: value方法 访问这个请求根据url查找对应的执行的方法在通过java反射执行该方法。 高仿 SpringMVC 框架 适配器模式 定义：将
从0开始仿写一个SpringMvc框架（1）
qq_30765051的博客
10-12 430
仿写SpringMvc（简单版）要实现的功能：扫描注解、控制反转、实现BeanFactory、整合tomcat、实现DispatcherServlet。 本项目基于idea开发 1、建立项目，新建一个maven工程导入相关依赖，主要是tomcat的依赖和配置打成jar包后程序的入口 <dependencies> <dependency> ...
深入底层，仿SpringMVC自己写框架
lovezhaohaimig的博客
05-21 411
SpringMVC实现原理：核心组件：1.DispatcherServlet：前端控制器，是整个流程控制的核心，控制其他组件的执行，统一调度，降低组件之间的耦合性，相当于总指挥。2.Handler：处理器，完成具体业务逻辑，相当于Servlet或Action。3.HandlerMapping：DispatcherServlet接收到请求之后，通过HandlerMapping将不同的请求分发到不同的...
Springboot通过接口获取实现类的RequestMapping请求路径
qq_34168515的博客
05-28 5865
文章目录一、前言 --- 灵活使用 ApplicationContext二、获取所有路径2.1 定义测试controller2.2 实现获取所有路径的代码三、通过接口获取实现类的RequestMapping请求路径3.1 定义一个接口3.2 controller实现该接口 一、前言 — 灵活使用 ApplicationContext Springboot是一个很灵活的框架，借助这个框架可以实现很多我们需要的功能，下面我来简单介绍一下ApplicationContext 这个类 如果说BeanFactory是
Spring 获取自定义注解所有类
一个写了10年bug的程序员日常笔记。
06-11 1万+
import org.springframework.beans.BeansException; import org.springframework.context.ApplicationContext; import org.springframework.context.ApplicationContextAware; import org.springframework.context...
Spring获取某个包下带有特定注解的所有类的集合
最新发布
cong__cong__cong的博客
08-16 683
【代码】Spring获取某个包下带有特定注解的所有类的集合。
Spring注解开发：@Controller与@RequestMapping详解
"本文将详细解析Spring框架中的注解开发模式，特别是`@Controller`和`@RequestMapping`的使用，以及如何配置Spring MVC以支持这些注解。" Spring框架引入注解开发模式后，极大地简化了Java应用的配置，使得开发者...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值