最近一直在做一些代码自动化生成工作，主要目标是从业务需求的配置文件可以直接生成 Android 和 iOS 的 UI 代码。在 Android 平台在生成 Activity 时，会默认使用 ButtetKnife 来处理事件绑定的工作。
配置文件的片断如下：
{
"id": "tvName",
"type": "TextView",
"style": {
"layout_width": "match_parent",
"layout_height": "match_parent"
},
"event": {
"onClick": "function(view){
//自定义代码
}"
}
}
这段配置很简单、也很容易理解，了解Android开发的同学一下就能看明白，它就是一个 layout 文件和 UI 事件的一个整合。event 部分会在 Activity 中生成如下代码：
private TextView tvName;
public void onCreate(Bundle savedInstanceState) {
...
tvName = (TextView)findViewById(R.id.tvName);
tvName.setOnClickListener(tvNameOnOnClickListener);
}
private View.OnClickListener tvNameOnOnClickListener = new View.OnClickListener() {
@Override
public void onClick(View view) {
}
};
生成的代码分为三部分，分别是控件的声明、初始化以及 OnClick 事件的实现部分。为了提高代码的简洁性，后来做出了一版修改，生成使用了 ButterKnife 的源代码，代码如下：
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout...);
ButterKnife.bind(this);
}
@OnClick(R.id.tvName)
public void tvNameOnClick() {
...
}
控件的声明部分已经不再需要，通过ButterKnife 自动绑定，而onCreate部分是固定不变的，所以在 ButterKnife 模式下，真正的生成代码只有 tvNameOnClick 部分了，可谓是相当简洁。
对于这两版生成的代码，虽然代码量和简洁性差距很大，但是从生成难度上讲，几乎没有区别。所以我一直是偏爱第二种生成风格的。但是不管是哪种风格，关于 Event 生成这里一直都有几个亟待解决的问题，那就是：
- 如何从一个配置文件的 Event 描述上，匹配到真正的 Android UI Event
- 如何得到任意一个 Event Listener 的原型
- 如何得到任意一个 Event Listener 在控件对象上的 Setter 方法，以及 Setter 方法的原型
- 自定义控件的自定义事件以及包含多个 Callback 的 Event Listener 该如何处理
在配置文件的 TextView 控件中描述了一个如下事件：
"event": {
"onClick": "function(view){
//自定义代码
}"
}
那么如何判断一个 TextView 是否具有一个 onClick 事件呢？所以这里就需要为每一个控件定义一个 metadata 文件或者类头文件的东西，以用于描述一个控件到底具有哪些事件。在生成的时候，用配置文件中的事件名字去查表检测是否存在这个事件。
检测到事件是否存在才是万里长征第一步，接下来的问题就是如何判断配置文件中书写的事件是否符合 Event Listener 的原型，以及这个 metadata 文件又应该如何来设计呢？
刚开始做时也没有啥经验，就只能凭空设计了，以下是一个 OnClickListener 的原型：
public interface OnClickListener {
void onClick(View var1);
}
生成的代码如下：
private View.OnClickListener tvNameOnOnClickListener = new View.OnClickListener() {
@Override
public void onClick(View view) {
...
}
};
所以在最早的实现中，就直接简短粗暴的使用了一个模板代码：
private View.OnClickListener {{listenerName}} = new View.OnClickListener() {
@Override
public void onClick(View view) {
{{body}}
}
};
但是这样带来的问题就是无法进行函数原型检测
接下来的问题就是如何知道一个Listener的Setter方法是什么呢？一个标准的Listener Setter 一般是 setOnClickListener，setOnLongClickListener 这样。但是如果第三方控件不是按这样的规则命名或则setXXXListener 需要更多的参数的时候，该怎么办呢？
我们先来看看 ButterKnife 是怎么做的？找到一个 OnClick Annotation 的源代码：
@Target(METHOD)
@Retention(CLASS)
@ListenerClass(
targetType = "android.view.View",
setter = "setOnClickListener",
type = "butterknife.internal.DebouncingOnClickListener",
method = @ListenerMethod(
name = "doClick",
parameters = "android.view.View"
)
)
public @interface OnClick {
/** View IDs to which the method will be bound. */
int[] value() default { View.NO_ID };
}
可以看到 ButterKnife 在这个 Annotation 中完整的描述了一个 Event Listener 涉及到的所有信息，Listener 的原型和 Setter 的原型。这个 Listener 的 type 是 DebouncingOnClickListener，对应需要调用的方法是 doClick， 而这个doClick的原型是接受一个View 类型的参数，returnType 没有写，默认为 void。
所以看到这里基本上也能想通，不管实现代码是否高大上，上述提到的信息都必不可少。下面这一段是我最早设计的一个控件的 metadata 文件片段，
private View.OnClickListener {{listenerName}} = new View.OnClickListener() {
@Override
public void onClick(View v) {
{{body}}
}
};
event: {
onClick: {
name: 'OnClickListener',
setter: '{{objName}}.setOnClickListener({{listenerName}});',
listener: //上面模板代码的引用
}
虽然在短期内解决了事件代码生成的问题，但是上面提到的问题一个都没有解决，不能原型检测，不能支持自定义控件以及多函数Listener。
所以新的 metadata 文件设计应运而生：
export interface View {
type: string;
id: string;
style: Style;
event: Event;
}
export interface Event {
onClick: onClick;
onLongClick: onLongClick;
}
export interface onClick {
(view: View): void;
}
export interface onLongClick {
(view: View): void;
}
这段文件完整的描述了一个View控件应该具有哪些属性，其中的 event 属性是一个 Event类型，而Event类型下面有两个属性，分别是两个函数原型。有了这部分信息，就可以在代码生成的时候完美检测配置文件的事件是否是该控件所具有的属性，以及函数原型是否正确。
export interface EventSetter {
onClick: setOnClickListener;
onLongClick: setOnLongClickListener;
}
interface setOnClickListener {
(onClick: onClick): void;
}
interface setOnLongClickListener {
(onLongClick: onLongClick): void;
}
另外一部分就是 Setter 问题，通过上述代码，也完整的描述了一个 Listener Setter 的 name 以及接受的函数原型，对于多函数 Listener 也能轻易处理了。
网友评论