第一个AndroidStudio插件，一键创建Activity
前言
之前写过一个创建Activity的Gradle插件CreateActivityPlugin，但是使用起来并非像使用AndroidStudio自带的功能new Activity一样方便。
而且我也做了一些思考，觉得创建Activity这个过程，其实和Gradle没什么关系。Gradle主要做的应该是帮助我们构建编译项目，而我们创建Activity仅仅是创建修改文件罢了。
正好最近公司Android组内想利用AS插件做一些便于开发的基础建设，我这里就写了一个demo来做个尝试。
所谓的插件，在我看来其实就是对于主程序的一个功能的扩展。不同的人使用AS肯定有一些特殊的需求，但是AndroidStudio开发者不可能预见所有的需要，统统加入到主程序中来。这时候就需要我们自己编写插件，来扩展主程序，满足我们的需求。
准备工作
1.下载开发工具IntelliJ IDEA
由于AndroidStudio是基于IntelliJ IDEA的开源版本做的，所以开发AndroidStudio的插件 ，其实就是开发IntelliJ IDEA的插件。而开发IntelliJ IDEA插件，要用到的就是IntelliJ IDEA。所以我们要去官网，下载免费的社区(Community)版本。
2.知悉开发流程
这里是IntelliJ IDEA插件开发的指南，我就是看着这个来开发的。
我在我的项目里引入了两个官方的例子：
就是sample包下的HelloAction和TextBoxes。
HelloAction和TextBoxes都继承自AnAction，AnAction是什么呢，用通俗的话来说就是一个动作。
我们点击AS中某个按钮的时候，触发的就是一个AnAction，可以类比Android中的OnClickListener。然后我们继承AnAction，要实现它的一个方法public abstract void actionPerformed(AnActionEvent e);，可以类比OnClickListener的void onClick(View v);。
在actionPerformed方法中我们写的是这个动作触发时我们应该去做的事情，然后该方法有一个入参AnActionEvent，它包含了你可能需要的状态，信息等，比方说我在哪里触发了这个点击事件(哪个文件下)。
AnAction写好了以后，我们还要像注册Activity一样在一个文件中将它注册(也可以用Java代码注册)：
注意看一下我在上图中的注释，是不是很好理解呢，当你引入(不会引入插件的自行百度)了我的这个插件，你就可以看到：
比如点击HelloAction，会出现如下弹窗：
一键创建Activity
1.展示创建Activity的弹窗
我们回想下，我们如果利用AndroidStudio的new Activity功能是如何创建Activity的？
是先右键点击一个文件夹，然后在一个弹窗中输入信息，然后确认，创建Activity的吧：
我这里创建了一个叫CreateActivityAction的AnAction，我在actionPerformed方法中去展示了一个弹窗CreateActivityDialog。
弹窗的代码如下，用的是Java GUI的那一套，因为这个是运行在AndroidStudio上的嘛，我尽可能用Android的方式去写了代码：
public class CreateActivityDialog extends JFrame {
private OnConfirmClickListener onConfirmClickListener;
private CreateActivityDialog() {
}
/**
* 展示弹窗
*/
public void showDialog() {
setSize(320, 120);
// 设置点击左上角x按钮, 仅退出JFrame界面
setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
// 创建面板, 类似Android的RelativeLayout
JPanel panel = new JPanel();
// 添加面板
add(panel);
// 调用用户定义的方法并添加组件到面板
placeComponents(panel);
// 让JFrame位于屏幕中央
setLocationRelativeTo(null);
// 设置界面可见
setVisible(true);
}
/**
* 调用用户定义的方法并添加组件到面板
*
* @param panel
*/
private void placeComponents(JPanel panel) {
// 这边设置布局为null
panel.setLayout(null);
// JLabel类似Android的TextView
JLabel activityLabel = new JLabel("ActivityName:");
// 这个方法定义了组件的位置
activityLabel.setBounds(10, 20, 110, 25);
panel.add(activityLabel);
// JTextField类似Android的EditText
JTextField activityText = new JTextField(20);
activityText.setBounds(110, 20, 165, 25);
panel.add(activityText);
// 创建按钮, 类似Android的Button
JButton createButton = new JButton("create Activity");
createButton.setBounds(90, 60, 140, 25);
createButton.addActionListener(new ActionListener() {
@Override
public void actionPerformed(ActionEvent e) {
// 界面消失, 释放JFrame资源
dispose();
if (onConfirmClickListener != null) {
onConfirmClickListener.onConfirm(activityText.getText());
}
}
});
panel.add(createButton);
}
public static class Builder {
private CreateActivityDialog dialog;
public Builder() {
dialog = new CreateActivityDialog();
}
public Builder setOnConfirmClickListener(OnConfirmClickListener onConfirmClickListener) {
dialog.setOnConfirmClickListener(onConfirmClickListener);
return this;
}
public CreateActivityDialog build() {
return dialog;
}
}
public CreateActivityDialog setOnConfirmClickListener(OnConfirmClickListener onConfirmClickListener) {
this.onConfirmClickListener = onConfirmClickListener;
return this;
}
public interface OnConfirmClickListener {
void onConfirm(String activityName);
}
}
实际效果如下：
哈哈，界面有点low。
然后你输入ActivityName，点击create Activity按钮，我就根据你输入的ActivityName去创建文件了。
2.创建Activity的文件，并注册。
分为以下3步：
- 生成layout文件
- 生成Java文件
- 将Activity注册到AndroidManifest
具体代码如下：
/**
* 创建Activity
*
* @param event
* @param activityName
*/
private void createActivity(AnActionEvent event, String activityName) {
if (TextUtils.isEmpty(activityName)) {
return;
}
VirtualFile file = event.getData(PlatformDataKeys.VIRTUAL_FILE);
// 生成layout文件
String layoutName = generateLayout(file, activityName);
// 生成Java文件
String fullClassName = generateJavaFile(file, activityName, layoutName);
// 将Activity注册到AndroidManifest
registerToManifest(file, fullClassName);
}
/**
* 生成layout文件
*
* @param file
* @param activityName
* @return layout的名字
*/
private String generateLayout(VirtualFile file, String activityName) {
String filePath = file.getPath();
StringBuilder sb = new StringBuilder("activity");
int rightBorder = activityName.length() - "activity".length();
for (int i = 0; i < rightBorder; i++) {
if (Character.isUpperCase(activityName.charAt(i))) {
// 如果是大写
sb.append("_");
}
sb.append(Character.toLowerCase(activityName.charAt(i)));
}
String layoutName = sb.toString();
String src_main = "src/main/";
int index = filePath.indexOf(src_main) + src_main.length();
while (true) {
String layoutPath = filePath.substring(0, index) +
"res/layout/" +
layoutName +
".xml";
File layoutFile = new File(layoutPath);
if (!layoutFile.exists()) {
// 如果layout文件不存在, 去创建
try {
layoutFile.createNewFile();
writeFile(layoutPath, generateXmlContent());
} catch (IOException e) {
layoutName = null;
}
break;
} else {
// 如果layout文件存在, 修改文件名
layoutName += "_1";
}
}
return layoutName;
}
/**
* 生成Java文件
*
* @param file
* @param activityName
* @param layoutName
* @return Activity的全类名
*/
private String generateJavaFile(VirtualFile file, String activityName, String layoutName) {
// 生成Java文件内容
String importPath = getImportPath(file);
String rPath = getRPath(file);
String content = generateJavaContent(importPath, rPath, activityName, layoutName);
// 生成Java文件
String javaPath = file.getPath()
+ "/"
+ activityName
+ ".java";
File newFile = new File(javaPath);
try {
newFile.createNewFile();
} catch (IOException e) {
e.printStackTrace();
}
// 写入Java文件内容
writeFile(javaPath, content);
String fullClassName = importPath + "." + activityName;
return fullClassName;
}
/**
* 将Activity注册到AndroidManifest
*
* @param file
* @param fullClassName
*/
private void registerToManifest(VirtualFile file, String fullClassName) {
FileReader reader = null;
FileWriter writer = null;
BufferedReader bufferedReader = null;
try {
String manifestPath = getManifestPath(file.getPath());
reader = new FileReader(manifestPath);
bufferedReader = new BufferedReader(reader);
StringBuilder sb = new StringBuilder();
// 每一行的内容
String line = "";
while ((line = bufferedReader.readLine()) != null) {
// 找到application节点的末尾
if (line.contains("</application>")) {
// 在application节点最后插入新创建的activity节点
String activityNode = generateActivityNodeContent(fullClassName);
sb.append(activityNode + "\n");
}
sb.append(line + "\n");
}
String content = sb.toString();
// 删除最后多出的一行
content = content.substring(0, content.length() - 1);
writer = new FileWriter(manifestPath);
writer.write(content);
} catch (Exception e) {
e.printStackTrace();
} finally {
if (bufferedReader != null) {
try {
bufferedReader.close();
} catch (IOException e) {
e.printStackTrace();
}
}
if (reader != null) {
try {
reader.close();
} catch (IOException e) {
e.printStackTrace();
}
}
if (writer != null) {
try {
writer.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
}
/**
* 获取当前的导包路径
*
* @param file
* @return
*/
private String getImportPath(VirtualFile file) {
String path = file.getPath();
String str = "src/main/java/";
int index = path.indexOf(str) + str.length();
String importPath = path.substring(index, path.length());
importPath = importPath.replace("/", ".");
return importPath;
}
/**
* 获取AndroidManifest文件的路径
*
* @param filePath
* @return
*/
private String getManifestPath(String filePath) {
String str = "/src/main";
int index = filePath.indexOf(str) + str.length();
return filePath.substring(0, index) + "/AndroidManifest.xml";
}
/**
* 通过解析AndroidManifest文件
* 获取R文件的路径
*
* @param file
* @return
*/
private String getRPath(VirtualFile file) {
String manifestPath = getManifestPath(file.getPath());
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
try {
DocumentBuilder documentBuilder = factory.newDocumentBuilder();
File manifestFile = new File(manifestPath);
Document doc = documentBuilder.parse(manifestFile);
Element root = doc.getDocumentElement();
// 获取manifest节点下的package属性
String packageName = root.getAttribute("package");
return packageName;
} catch (Exception e) {
e.printStackTrace();
}
return null;
}
/**
* 生成xml内容
*
* @return
*/
private String generateXmlContent() {
return XmlTemplate.template;
}
/**
* 生成Java文件内容
*
* @param importPath
* @param rPath
* @param activityName
* @param layoutName
* @return
*/
private String generateJavaContent(String importPath, String rPath, String activityName, String layoutName) {
String content = String.format(ActivityTemplate.template, importPath, rPath, activityName, layoutName);
return content;
}
/**
* 生成Activity节点内容
*
* @param fullClassName
* @return
*/
private String generateActivityNodeContent(String fullClassName) {
String content = String.format(ActivityNodeTemplate.template, fullClassName);
return content;
}
/**
* 向文件写入内容
*
* @param file
* @param content
* @throws IOException
*/
private void writeFile(String file, String content) {
RandomAccessFile randomAccessFile = null;
try {
randomAccessFile = new RandomAccessFile(file, "rw");
if (randomAccessFile.length() > 2) {
randomAccessFile.seek(randomAccessFile.length() - 2);
}
randomAccessFile.write(content.getBytes("UTF-8"));
} catch (Exception e) {
e.printStackTrace();
} finally {
try {
randomAccessFile.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
如果你引入了我的插件，这时候就可以右一键生成Activity啦：
项目地址：FirstIntellijPlugin
可以对比我写的Gradle插件：CreateActivityPlugin，关于Gradle插件请看发布一个Gradle插件–实现一键创建Activity。