为了提高访问速度，在系统初次启动时需要做系统预热，然而使用单元测试耗时耗力，故写了一个注解，目前支持空参数和单个参数（多个参数也可以，只是要做args类型、数量判断）。
注解类：
@Target 表示该注解可以用于什么地方，可能的ElementType参数有：
-
CONSTRUCTOR：构造器的声明
-
FIELD：字段声明（包括enum实例）
-
LOCAL_VARIABLE：局部变量声明
-
METHOD：方法声明
-
PACKAGE：包声明
-
PARAMETER：参数声明
-
TYPE：类、接口（包括注解类型）或enum声明
这里使用METHOD。
@Retention 表示需要在什么级别保存该注解信息。可选的RetentionPolicy参数包括：
- SOURCE：注解将被编译器丢弃
- CLASS：注解在class文件中可用，但会被VM丢弃
- RUNTIME：VM将在运行期间保留注解，因此可以通过反射机制读取注解的信息
这里使用RUNTIME。
@Documented 将注解包含在Javadoc中
@Inherited 允许子类继承父类中的注解
package com.example.demo123.annotation;
import java.lang.annotation.*;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface CherryAnnotation {
String value();
}Class工具类：
主要作用是通过包名获取内部全部类的信息。
package com.example.demo123.util;
import java.io.File;
import java.io.FileFilter;
import java.io.IOException;
import java.net.JarURLConnection;
import java.net.URL;
import java.net.URLDecoder;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
public class ClassUtil {
/**
* 通过包名获取包内所有类
*
* @param pkg
* @return
*/
public static List<Class<?>> getAllClassByPackageName(Package pkg) {
String packageName = pkg.getName();
// 获取当前包下以及子包下所以的类
List<Class<?>> returnClassList = getClasses(packageName);
return returnClassList;
}
/**
* 通过接口名取得某个接口下所有实现这个接口的类
*/
public static List<Class<?>> getAllClassByInterface(Class<?> c) {
List<Class<?>> returnClassList = null;
if (c.isInterface()) {
// 获取当前的包名
String packageName = c.getPackage().getName();
// 获取当前包下以及子包下所以的类
List<Class<?>> allClass = getClasses(packageName);
if (allClass != null) {
returnClassList = new ArrayList<Class<?>>();
for (Class<?> cls : allClass) {
// 判断是否是同一个接口
if (c.isAssignableFrom(cls)) {
// 本身不加入进去
if (!c.equals(cls)) {
returnClassList.add(cls);
}
}
}
}
}
return returnClassList;
}
/**
* 取得某一类所在包的所有类名 不含迭代
*/
public static String[] getPackageAllClassName(String classLocation, String packageName) {
// 将packageName分解
String[] packagePathSplit = packageName.split("[.]");
String realClassLocation = classLocation;
int packageLength = packagePathSplit.length;
for (int i = 0; i < packageLength; i++) {
realClassLocation = realClassLocation + File.separator + packagePathSplit[i];
}
File packeageDir = new File(realClassLocation);
if (packeageDir.isDirectory()) {
String[] allClassName = packeageDir.list();
return allClassName;
}
return null;
}
/**
* 从包package中获取所有的Class
*
* @param pack
* @return
*/
private static List<Class<?>> getClasses(String packageName) {
// 第一个class类的集合
List<Class<?>> classes = new ArrayList<Class<?>>();
// 是否循环迭代
boolean recursive = true;
// 获取包的名字 并进行替换
String packageDirName = packageName.replace('.', '/');
// 定义一个枚举的集合 并进行循环来处理这个目录下的things
Enumeration<URL> dirs;
try {
dirs = Thread.currentThread().getContextClassLoader().getResources(packageDirName);
// 循环迭代下去
while (dirs.hasMoreElements()) {
// 获取下一个元素
URL url = dirs.nextElement();
// 得到协议的名称
String protocol = url.getProtocol();
// 如果是以文件的形式保存在服务器上
if ("file".equals(protocol)) {
// 获取包的物理路径
String filePath = URLDecoder.decode(url.getFile(), "UTF-8");
// 以文件的方式扫描整个包下的文件 并添加到集合中
findAndAddClassesInPackageByFile(packageName, filePath, recursive, classes);
} 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();
}
return classes;
}
/**
* 以文件的形式来获取包下的所有Class
*
* @param packageName
* @param packagePath
* @param recursive
* @param classes
*/
private static void findAndAddClassesInPackageByFile(String packageName, String packagePath, final boolean recursive, List<Class<?>> classes) {
// 获取此包的目录 建立一个File
File dir = new File(packagePath);
// 如果不存在或者 也不是目录就直接返回
if (!dir.exists() || !dir.isDirectory()) {
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));
} catch (ClassNotFoundException e) {
e.printStackTrace();
}
}
}
}
}注解工具类：
主要是通过反射获取类中的方法，判断是否存在指定的注解。如果存在再判断参数数量、类型，然后invoke。
package com.example.demo123.util;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.List;
import com.example.demo123.annotation.CherryAnnotation;
public class AnnotationUtil {
public static void validAnnotation(List<Class<?>> clsList) throws IllegalAccessException, InstantiationException, InvocationTargetException {
if (clsList != null && clsList.size() > 0) {
for (Class<?> cls : clsList) {
//获取类中的所有的方法
Method[] methods = cls.getDeclaredMethods();
if (methods != null && methods.length > 0) {
for (Method method : methods) {
CherryAnnotation cherryAnnotation= (CherryAnnotation) method.getAnnotation(CherryAnnotation.class);
if (cherryAnnotation != null) {
if(cherryAnnotation.value().equals("*")){
method.invoke(cls.newInstance());
}else{
method.invoke(cls.newInstance(),cherryAnnotation.value());
}
}
}
}
}
}
}
}
Controller:
不多说了
package com.example.demo123.controller;
import com.example.demo123.annotation.CherryAnnotation;
import org.springframework.web.bind.annotation.RequestMapping;
public class projectController {
@RequestMapping("/getAllProjectInfo")
@CherryAnnotation("*")
public void getAllProjectInfo(){
//执行查询语句后插入到Redis中
System.out.println("全部项目信息已成功加载到Redis中！");
}
}
package com.example.demo123.controller;
import com.example.demo123.annotation.CherryAnnotation;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.concurrent.TimeUnit;
@RestController
public class userController {
@RequestMapping("/getUserListByDepartmentID")
@CherryAnnotation("A118")
public void getUserList(String DepartmentID){
//执行查询语句后插入到Redis中
System.out.println(DepartmentID+"号部门人员列表数据已经成功加载到Redis中！");
}
}
启动运行类：
继承ApplicationRunner，编写启动时执行的方法。使得项目在启动后第一时间就把热点数据加载到Redis缓存中。
package com.example.demo123;
import com.example.demo123.controller.userController;
import com.example.demo123.util.AnnotationUtil;
import com.example.demo123.util.ClassUtil;
import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.stereotype.Component;
import java.util.List;
/**
* @author kabit
* createTime 2021-9-25 15:01
**/
@Component
public class Demo123ApplicationRunner implements ApplicationRunner {
@Override
public void run(ApplicationArguments args) throws Exception {
// 获取特定包下所有的类(包括接口和类)
List<Class<?>> clsList = ClassUtil.getAllClassByPackageName(userController.class.getPackage());
//输出所有使用了特定注解的类的注解值
AnnotationUtil.validAnnotation(clsList);
}
}最后结果：
好了，我也不知道为什么突然就想写一个这东西....
1018
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
