AI专业者开发社区 1 号成员
  •  0 回帖  •  8 浏览  •  5 个月前
   

SpringMVC的注解机制：Java中利用反射查找使用指定注解的类---找到指定包下的指定注解类

先扫描指定包下的所有的 class 文件，再找注解是 @Controller 文件的类文件，再找 RequestMapping 是 /about 的方法，并执行

应用：java 项目里用纯 servlet 写的项目 ，就可以做自己的注解映射路由了

定义注解

Controller.java

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Controller {

}

RequestMapping.java

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RequestMapping {

String value();


}

使用注解

@Controller
public class IndexController {

@RequestMapping("/")
public void index() {
System.out.println("index method")
}


@RequestMapping("/about")
public void about(String args) {
System.out.println("about method")
}


}

@Controller
public class TwoController {

@RequestMapping("/")
public void index() {
System.out.println("index method");
}


@RequestMapping("/about")
public void about(String args) {
System.out.println("two  about method");
}


}

扫描包下所有类

public class Scanner {
   /**
    * 从包 package 中获取所有的 Class
    *
    * @param packageName
    * @return
    */
   public  Set<Class<?>> getClasses(String packageName) throws Exception{

  </span><span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)"> 第一个class类的集合
  </span><span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)">List&lt;Class&lt;?&gt;&gt; classes = new ArrayList&lt;Class&lt;?&gt;&gt;();</span>
  Set&lt;Class&lt;?&gt;&gt; classes = <span style="color: rgba(0, 0, 255, 1)">new</span> HashSet&lt;&gt;<span style="color: rgba(0, 0, 0, 1)">();
  </span><span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)"> 是否循环迭代</span>
  <span style="color: rgba(0, 0, 255, 1)">boolean</span> recursive = <span style="color: rgba(0, 0, 255, 1)">true</span><span style="color: rgba(0, 0, 0, 1)">;
  </span><span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)"> 获取包的名字 并进行替换</span>
  String packageDirName = packageName.replace('.', '/'<span style="color: rgba(0, 0, 0, 1)">);
  </span><span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)"> 定义一个枚举的集合 并进行循环来处理这个目录下的things</span>
  Enumeration&lt;URL&gt;<span style="color: rgba(0, 0, 0, 1)"> dirs;
  </span><span style="color: rgba(0, 0, 255, 1)">try</span><span style="color: rgba(0, 0, 0, 1)"> {
    <span style="color: rgba(255, 0, 0, 1)"><strong> dirs </strong></span></span><span style="color: rgba(255, 0, 0, 1)"><strong>= Thread.currentThread().getContextClassLoader().getResources(packageDirName);
     </strong></span><span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)"> 循环迭代下去</span>
     <span style="color: rgba(0, 0, 255, 1)">while</span><span style="color: rgba(0, 0, 0, 1)"> (dirs.hasMoreElements()) {
        </span><span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)"> 获取下一个元素，URL的解释 <a href="https://www.cnblogs.com/lishanlei/p/9327646.html">https://www.cnblogs.com/lishanlei/p/9327646.html</a>  <a href="https://www.runoob.com/java/java-url-processing.html" rel="noopener nofollow">https://www.runoob.com/java/java-url-processing.html</a></span>
        URL url =<span style="color: rgba(0, 0, 0, 1)"> dirs.nextElement();
        </span><span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)"> 得到协议的名称</span>
        String protocol =<span style="color: rgba(0, 0, 0, 1)"> url.getProtocol();
        </span><span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)"> 如果是以文件的形式保存在服务器上</span>
        <span style="color: rgba(0, 0, 255, 1)">if</span> ("file"<span style="color: rgba(0, 0, 0, 1)">.equals(protocol)) {
           </span><span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)"> 获取包的物理路径</span>
           String filePath = URLDecoder.decode(url.getFile(), "UTF-8"<span style="color: rgba(0, 0, 0, 1)">);
           </span><span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)"> 以文件的方式扫描整个包下的文件 并添加到集合中，以下俩种方法都可以
           </span><span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)">网上的第一种方法，</span>



               findAndAddClassesInPackageByFile(packageName, filePath, recursive, classes);
//网上的第二种方法
//addClass(classes,filePath,packageName);
} else if ("jar".equals(protocol)) {
// 如果是 jar 包文件
// 定义一个 JarFile
               JarFile jar;
try {
// 获取 jar
jar = ((JarURLConnection) url.openConnection()).getJarFile();
// 从此 jar 包 得到一个枚举类
Enumeration<JarEntry> entries = jar.entries();
// 同样的进行循环迭代
while (entries.hasMoreElements()) {
// 获取 jar 里的一个实体 可以是目录 和一些 jar 包里的其他文件 如 META-INF 等文件
JarEntry entry = entries.nextElement();
String name = entry.getName();
// 如果是以 / 开头的
if (name.charAt(0) == '/') {
// 获取后面的字符串
name = name.substring(1);
}
// 如果前半部分和定义的包名相同
if (name.startsWith(packageDirName)) {
int idx = name.lastIndexOf('/');
// 如果以 "/" 结尾 是一个包
if (idx != -1) {
// 获取包名 把 "/" 替换成 "."
packageName = name.substring(0, idx).replace('/', '.');
}
// 如果可以迭代下去 并且是一个包
if ((idx != -1) || recursive) {
// 如果是一个.class 文件 而且不是目录
if (name.endsWith(".class") && !entry.isDirectory()) {
// 去掉后面的 ".class" 获取真正的类名
String className = name.substring(packageName.length() + 1, name.length() - 6);
try {
// 添加到 classes
classes.add(Class.forName(packageName + '.' + className));
} catch (ClassNotFoundException e) {
e.printStackTrace();
}
}
}
}
}
} catch (IOException e) {
e.printStackTrace();
}
}
}
} catch (IOException e) {
e.printStackTrace();
}


  </span><span style="color: rgba(0, 0, 255, 1)">return</span><span style="color: rgba(0, 0, 0, 1)"> classes;



}


public   void addClass(Set<Class<?>> classes, String filePath, String packageName) throws Exception{
File[] files=new File(filePath).listFiles(new FileFilter() {
@Override
public boolean accept(File file) {
return (file.isFile()&&file.getName().endsWith(".class"))||file.isDirectory();
}
});
for(File file:files){
String fileName=file.getName();
if(file.isFile()){
String classsName=fileName.substring(0,fileName.lastIndexOf("."));
if(! StringUtil.isBlank(packageName)){
classsName=packageName+"."+classsName;
}
doAddClass(classes,classsName);
}


  }



}


public   void doAddClass(Set<Class<?>> classes, final String classsName) throws Exception{
ClassLoader classLoader=new ClassLoader() {
@Override
public Class<?> loadClass(String name) throws ClassNotFoundException {
return super.loadClass(name);
}
};
//Class<?> cls= ClassLoader.loadClass(classsName);
      classes.add(classLoader.loadClass(classsName));
}


//找也用了 Controller 注解的类
private Set<Class<?>> controllers;


public Set<Class<?>> getControllers() throws Exception{
if (controllers == null) {
controllers = new HashSet<>();
Set<Class<?>> clsList = getClasses("aop_zdh.zhujie");
if (clsList != null && clsList.size() > 0) {
for (Class<?> cls : clsList) {
if (cls.getAnnotation(Controller.class) != null) {
Map<Class<?>, Object> map = new HashMap<>();
controllers.add(cls);
}
}
}
}
return controllers;
}
public void getMapping() throws Exception{
for (Class<?> cls : getControllers()) {
Method[] methods = cls.getMethods();
for (Method method : methods) {
RequestMapping annotation = method.getAnnotation(RequestMapping.class);
if (annotation != null) {
String value = annotation.value();//找到 RequestMapping 的注入 value 值
if (value.equals("/about")) {//判断是不是 /about，是的话，就调用 about(args) 方法
method.invoke(cls.newInstance(), "args"); //第二个参数是方法里的参数
               }
}
}
}
}
/**
* 以文件的形式来获取包下的所有 Class
*
* @param packageName
* @param packagePath
* @param recursive
* @param classes
*/
public static void findAndAddClassesInPackageByFile(String packageName,
String packagePath, final boolean recursive, Set<Class<?>> classes) {
// 获取此包的目录 建立一个 File
File dir = new File(packagePath);
// 如果不存在或者 也不是目录就直接返回
if (!dir.exists() || !dir.isDirectory()) {
// log.warn("用户定义包名" + packageName + "下没有任何文件");
return;
}
// 如果存在 就获取包下的所有文件 包括目录
File[] dirfiles = dir.listFiles(new FileFilter() {
// 自定义过滤规则 如果可以循环 (包含子目录) 或则是以.class 结尾的文件 (编译好的 java 类文件)
public boolean accept(File file) {
return (recursive && file.isDirectory())
|| (file.getName().endsWith(".class"));
}
});
// 循环所有文件
for (File file : dirfiles) {
// 如果是目录 则继续扫描
if (file.isDirectory()) {
findAndAddClassesInPackageByFile(packageName + "."
+ file.getName(), file.getAbsolutePath(), recursive,
classes);
} else {
// 如果是 java 类文件 去掉后面的.class 只留下类名
String className = file.getName().substring(0,
file.getName().length() - 6);
try {
// 添加到集合中去
//classes.add(Class.forName(packageName + '.' + className));
//经过回复同学的提醒，这里用 forName 有一些不好，会触发 static 方法，没有使用 classLoader 的 load 干净
classes.add(Thread.currentThread().getContextClassLoader().loadClass(packageName + '.' + className));
} catch (ClassNotFoundException e) {
// log.error("添加用户自定义视图类错误 找不到此类的.class 文件");
               e.printStackTrace();
}
}
}
}


public static void main(String[] args)throws Exception {
new Scanner().getMapping();
}
}

运行结果显示如下：

about method
two  about method

 涉及到的 URL 知识点见如下两个大佬缩写：

file 协议与 http 协议的区别

https://www.cnblogs.com/lishanlei/p/9327646.html
这个是专门介绍 URL 的
  https://www.runoob.com/java/java-url-processing.html