5.7实现服务端自动注册服务
到目前为止，客户端看起来挺完美了，但是在服务端，我们却需要手动创建服务对象，并且手动进行注册，如果服务端提供了很多服务，这个操作就会变得很繁琐。本节就会介绍如何基于注解进行服务的自动注册。需要反射的一些知识。
5.7.1定义注解
首先我们需要定义两个注解：Service 和 ServiceScan：
Service.java
@Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) public @interface Service { public String name() default ""; }
ServiceScan.java
@Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) public @interface ServiceScan { public String value() default ""; }
- @Service 放在一个类上，标识这个类提供一个服务。Service 注解的值定义为该服务的名称，默认值是该类的完整类名。
- @ServiceScan 放在启动的入口类上（main 方法所在的类），标识服务的扫描的包的范围。ServiceScan 的值定义为扫描范围的根包，默认值为入口类所在的包，扫描时会扫描该包及其子包下所有的类，找到标记有 Service 的类，并注册。
5.7.2工具类 ReflectUtil
这个类是一系列工具方法，不做讲解，只说用途，感兴趣的可以研究研究具体实现：
public class ReflectUtil { public static String getStackTrace() { StackTraceElement[] stack = new Throwable().getStackTrace(); return stack[stack.length - 1].getClassName(); } public static Set<Class<?>> getClasses(String packageName) { Set<Class<?>> classes = new LinkedHashSet<>(); boolean recursive = true; String packageDirName = packageName.replace('.', '/'); 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) { // log // .error("添加用户自定义视图类错误 找不到此类的.class文件"); e.printStackTrace(); } } } } } } catch (IOException e) { // log.error("在扫描用户定义视图时从jar包获取文件出错"); e.printStackTrace(); } } } } catch (IOException e) { e.printStackTrace(); } return classes; } private 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(); } } } } }
主要就是 getClasses 方法，传入一个包名，用于扫描该包及其子包下所有的类，并将其 Class 对象放入一个 Set 中返回。
5.7.3扫描服务
由于扫描服务这一步是一个比较公共的方法，无论是 Socket 还是 Netty 的服务端都需要这个方法，于是我对项目做了一点重构，使用了一个抽象类 AbstractRpcServer 实现了 RpcServer 接口，而 NettyServer 和 SocketServer 继承自 AbstractRpcServer，将 scanServices 方法放在抽象类中，而 start 方法则由具体实现类来实现。
scanServices 方法如下：
public void scanServices() { String mainClassName = ReflectUtil.getStackTrace(); Class<?> startClass; try { startClass = Class.forName(mainClassName); if(!startClass.isAnnotationPresent(ServiceScan.class)) { logger.error("启动类缺少 @ServiceScan 注解"); throw new RpcException(RpcError.SERVICE_SCAN_PACKAGE_NOT_FOUND); } } catch (ClassNotFoundException e) { logger.error("出现未知错误"); throw new RpcException(RpcError.UNKNOWN_ERROR); } String basePackage = startClass.getAnnotation(ServiceScan.class).value(); if("".equals(basePackage)) { basePackage = mainClassName.substring(0, mainClassName.lastIndexOf(".")); } Set<Class<?>> classSet = ReflectUtil.getClasses(basePackage); for(Class<?> clazz : classSet) { if(clazz.isAnnotationPresent(Service.class)) { String serviceName = clazz.getAnnotation(Service.class).name(); Object obj; try { obj = clazz.newInstance(); } catch (InstantiationException | IllegalAccessException e) { logger.error("创建 " + clazz + " 时有错误发生"); continue; } if("".equals(serviceName)) { Class<?>[] interfaces = clazz.getInterfaces(); for (Class<?> oneInterface: interfaces){ publishService(obj, oneInterface.getCanonicalName()); } } else { publishService(obj, serviceName); } } } }
我们首先需要获得要扫描的包的范围，就需要获取到 ServiceScan 注解的值，而我们前面说过，这个注解是加在启动类上的，那么，我们怎么知道启动类是哪一个呢？答案是通过调用栈。方法的调用和返回是通过方法调用栈来实现的，当调用一个方法时，该方法入栈，该方法返回时，该方法出栈，控制回到栈顶的方法。那么，main 方法一定位于调用栈的最底端，在 ReflectUtils 中，我写了一个 getStackTrace 方法（名字起得不好），用于获取 main 所在的类。通过 Class 对象的 isAnnotationPresent 方法来判断该类是否有 ServiceScan 注解。如果有，通过startClass.getAnnotation(ServiceScan.class).value(); 获取注解的值。
当获得扫描的范围后，就可以通过ReflectUtil.getClasses(basePackage) 获取到所有的 Class 了，逐个判断是否有 Service 注解，如果有的话，通过反射创建该对象，并且调用 publishService 注册即可。
5.7.4开启自动注册服务并测试
以 NettyServer 为例，在 NettyServer 的构造方法最后，调用 scanServices 方法，即可自动注册所有服务：
public NettyServer(String host, int port, Integer serializer) { this.host = host; this.port = port; serviceRegistry = new NacosServiceRegistry(); serviceProvider = new ServiceProviderImpl(); this.serializer = CommonSerializer.getByCode(serializer); // 服务端调用scanServices，自动扫描服务 scanServices(); }
不要忘了在 HelloServiceImpl 类上加上 @service 注解（标识这个类提供一个服务）：
@Service public class HelloServiceImpl implements HelloService { @Override public String hello(String name) { return "Hello, " + name; } }
并且在服务器启动类上加上注解：
@ServiceScan public class NettyTestServer { public static void main(String[] args) { NettyServer server = new NettyServer("127.0.0.1", 9999, CommonSerializer.PROTOBUF_SERIALIZER); server.start(); } }
直接使用启动类所在的包作为扫描根包。
启动类变得无比简洁！启动后应该能看到和之前相同的结果。
6.项目中遇到哪些问题/难点
待补充。。。
