2024年HarmonyOS鸿蒙最全Sword - 为 Kotlin 函数增加代理功能(三)_valfq，面试经历分享怎么说

深知大多数程序员，想要提升技能，往往是自己摸索成长，但自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上鸿蒙开发知识点，真正体系化！

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新

需要这份系统化的资料的朋友，可以戳这里获取

2. Sword - 为 Kotlin 函数增加代理功能(二)

前面两篇文章笔者记录了 Sword 的实现过程，本篇文章简单记录下如何使用 Sword 以及如何通过 KSP 为 InvocationHandler 生成 FqName 索引类 HandlerFqName。

下面我们先看下如何使用 Sword 吧。

应用

 // `InvocationHandler` 实现类1
 class GetTextNoArgInvocationHandler : InvocationHandler {
 ​
     private val TAG = GetTextNoArgInvocationHandler::class.java.simpleName
 ​
     override fun invoke(className: String, methodName: String, args: Array<Any?>): Any? {
         Log.e(TAG, "invoke: className = $className, methodName = $methodName, args(${args.size}) = ${args.joinToString()}")
         return "guodongAndroid-Debug"
     }
 }
 ​
 // `InvocationHandler` 实现类2
 class GetTextArgInvocationHandler : InvocationHandler {
 ​
     private val TAG = GetTextArgInvocationHandler::class.java.simpleName
 ​
     override fun invoke(className: String, methodName: String, args: Array<Any?>): Any? {
         Log.e(TAG, "invoke: className = $className, methodName = $methodName, args(${args.size}) = ${args.joinToString()}")
         return User("guodongAndroid-Debug", 18)
     }
 }

在上面的代码片段中，笔者创建了两个 InvocationHandler 实现类，对原始函数的返回值进行了替换，接下来创建测试类：

向 Proxy 注解中的 handler 参数注入 InvocationHandler 实现类的全限定名(Fully Qualified Name)，其实现类必须有无参构造方法。

 // 测试类
 class Test {
 ​
     @Proxy(
         enable = BuildConfig.isDebug,
         // 注入 `InvocationHandler` 实现类的全限定名
         handler = "com.guodong.android.sword.app.GetTextNoArgInvocationHandler"
     )
     fun getTextNoArg() = "guodongAndroid"
 ​
     @Proxy(
         enable = BuildConfig.isDebug,
         // 注入 `InvocationHandler` 实现类的全限定名
         handler = "com.guodong.android.sword.app.GetTextArgInvocationHandler"
     )
     fun getTextArg(
         b: Byte,
         z: Boolean,
         c: Char,
         s: Short,
         i: Int,
         l: Long,
         f: Float,
         d: Double,
         str: String,
         ia: IntArray,
         sa: Array<String>,
         ls: List<String>,
         lls: List<List<String>>,
         map: Map<String, String>,
         user: User,
         callback: Callback,
     ): User {
         return User("guodongAndroid-Release", 28)
     }
 }

笔者创建了两个测试函数：getTextNoArg 和 getTextArg，一个函数没有参数，另一个函数有多个不同类型的参数。这两个函数上都有 Proxy 注解，并且注解的参数 enable 都处于开启状态，handler 参数都注入了对应 InvocationHandler 实现类的全限定名。

下面执行测试逻辑，分别调用上述两个函数：

 val test = Test()
 ​
 val textNoArg = test.getTextNoArg()
 Log.e(TAG, "onCreate: textNoArg = ${textNoArg.length}")
 ​
 val textArg = test.getTextArg(
     1,
     false,
     'A',
     1,
     1,
     1,
     1F,
     1.0,
     "test",
     intArrayOf(),
     Array(0) { "" },
     listOf(),
     listOf(),
     mapOf(),
     User("1", 1),
     object : Callback {
         override fun onSuccess() {
         }
 ​
         override fun onFailure(cause: Throwable) {
         }
     })
 Log.e(TAG, "onCreate: textArg = $textArg")

原始输出结果：

 1.MainActivity: onCreate: textNoArg = 14
 2.MainActivity: onCreate: textArg = User(name=guodongAndroid-Release, age=28)

代理输出结果：

 1.GetTextNoArgInvocationHandler: invoke: className = Test, methodName = getTextNoArg, args(0) = 
 2.MainActivity: onCreate: textNoArg = 20
 3.GetTextArgInvocationHandler: invoke: className = Test, methodName = getTextArg, args(16) = 1, false, A, 1, 1, 1, 1.0, 1.0, test, [I@156552e7, [Ljava.lang.String;@110de94, [], [], {}, User(name=1, age=1), com.guodong.android.sword.app.MainActivity$onCreate$textArg$2@12780d3d
 4.onCreate: textArg = User(name=guodongAndroid-Debug, age=18)

从上面的输出结果可以看出，Proxy 注解生效了：调用上述两个函数后成功执行了代理类的 invoke 函数。

至此，Sword 的使用就结束了，是不是比较简单呢？

但是这里有个问题：我们在给 Proxy 注解的 handler 参数注入 InvocationHandler 实现类的全限定名时使用的是硬编码，如果我们修改了实现类的类名，而忘记修改此处的全限定名，代码在运行时就会发生错误了。

针对这个问题，笔者的第一想法是使用 handler = GetTextNoArgInvocationHandler::class.java.name，但是不行，注解参数必须是编译期常量，此路不通了。

后面笔者想到一种方案：为 InvocationHandler 的实现类生成全限定名索引。

此方案参考自 EventBus 为 Event 事件生成 EventIndex ，不过 EventBus 使用 APT 技术进行实现，而 Sword 选择使用 KSP 实现。

接下来我们就看看如何为 InvocationHandler 的实现类生成全限定名索引吧。

首先看下最后的索引类 HandlerFqName 效果：

HandlerFqName

 // The file is automatic generated by Sword, don't modify it.
 package com.guodong.android.sword.app
 ​
 import kotlin.String
 ​
 /**
  * The class is automatic generated by Sword, don't modify it.
  *
  * [com.guodong.android.sword.api.kt.InvocationHandler]实现类的全限定名
  */
 public object HandlerFqName {
   /**
    * [com.guodong.android.sword.app.GetTextArgInvocationHandler]
    */
   public const val GetTextArgInvocationHandler: String =
       "com.guodong.android.sword.app.GetTextArgInvocationHandler"
 ​
   /**
    * [com.guodong.android.sword.app.GetTextNoArgInvocationHandler]
    */
   public const val GET_TEXT_NO_ARG: String =
       "com.guodong.android.sword.app.GetTextNoArgInvocationHandler"
 }

ProxyHandler

 /**
  * 标记[InvocationHandler]的实现类, 为其生成`FqName`索引类`HandlerFqName`
  *
  * 使用 ksp 实现
  */
 @Target(AnnotationTarget.CLASS)
 @Retention(AnnotationRetention.BINARY)
 annotation class ProxyHandler(
     /**
      * 生成字段的名称, 默认为类名
      *
      * `paramName`参数名称不要随意变动
      */
     val paramName: String = ""
 )

在 api-kotlin 模块中新增 ProxyHandler 注解，此注解用于标记 InvocationHandler 的实现类，为其生成FqName索引，比如我们标记在 GetTextNoArgInvocationHandler 类上：

 @ProxyHandler("GET_TEXT_NO_ARG")
 class GetTextNoArgInvocationHandler : InvocationHandler

其中 paramName 参数可以指定生成字段的名称，如果没有设置，默认生成的字段名称为实现类的类名：HandlerFqName.GetTextArgInvocationHandler。

KSP

KSP 基于 KCP 实现，提供了一个简化的编译器插件 API，与 KCP 陡峭的学习曲线相比，KSP 的学习曲线要平滑一些。

如何使用 KSP 读者可以参考官网，本文就不记录搭建 KSP 开发环境了，直接进入正题。

笔者先描述下自己的实现思路：

0. 首先判断当前模块是否有 InvocationHandler 接口，如若没有，则不处理，

1. 其次判断当前模块是否有 ProxyHandler 注解，如若没有，则不处理，

2. 以上两个条件都满足的，再获取包含 ProxyHandler 注解的所有 Kotlin 符号，

3. 对获取的 Kotlin 符号进行几种条件过滤，目的是确保此符号是 InvocationHandler 接口的实现类，过滤条件：

   0. 判断是否是类，而不是接口、枚举类等，
   1. 判断类是否是公开且不是抽象类，确保当前类可以访问并直接实例化，
   2. 判断是否有主构造方法或主构造方法没有参数，确保有无参构造方法，
   3. 最后判断当前类是否实现了 InvocationHandler 接口。

4. 通过过滤后的符号，收集并存储要生成的字段名和全限定名，

5. 最后通过 KotlinPoet 生成索引类。

下面根据实现思路依次实现。 首先定义一些常量，用于后面代码的编写：

 companion object {
     // 对应`ProxyHandler`注解里的`paramName`参数名称
     private const val PARAM_NAME = "paramName"
 ​
     // 生成索引类的包名，提供给外部配置，默认`com.guodong.android.sword`
     private const val PACKAGE_NAME_PARAM_NAME = "sword.pkg"
 ​
     // 默认索引类的包名
     private const val DEFAULT_PACKAGE_NAME = "com.guodong.android.sword"

     // 索引类所在文件名
     private const val FILE_NAME = "HandlerFqName"

     // 索引类的类名
     private const val CLASS_NAME = "HandlerFqName"
 }

再定义一个实体，用于存储生成的字段名和全限定名：

 data class ProxyHandlerParam(
     /**
      * 参数名称, 默认为类名
      */
     val paramName: String,
 ​
     /**
      * [InvocationHandler]实现类的全限定名
      *
      * e.g. com.example.ProxyTestInvocationHandler
      */
     val fqName: String,
 )

接下来主要分析 SymbolProcessor 的 process(resolver: Resolver) 函数，下面代码是思路中前两步的具体实现：

 private val mInvocationHandlerName = requireNotNull(InvocationHandler::class.qualifiedName)
 private val mProxyHandlerName = requireNotNull(ProxyHandler::class.qualifiedName)
 ​
 override fun process(resolver: Resolver): List<KSAnnotated> {
     // 判断当前模块是否有 `InvocationHandler` 接口，如若没有，则不处理


![img](https://img-blog.csdnimg.cn/img_convert/ae1e89e9c5e1031b257af36cf241d40b.png)
![img](https://img-blog.csdnimg.cn/img_convert/2ce6261d4ef2c326f2bbe28dca4bee40.png)

**网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。**

**[需要这份系统化的资料的朋友，可以戳这里获取](https://bbs.csdn.net/topics/618636735)**


**一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！**

er` 接口，如若没有，则不处理


[外链图片转存中...(img-2WxWv6cc-1715617372838)]
[外链图片转存中...(img-Z0I3n7bh-1715617372839)]

**网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。**

**[需要这份系统化的资料的朋友，可以戳这里获取](https://bbs.csdn.net/topics/618636735)**


**一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！**