自己动手写一个Android Studio插件

rl92939 5年前
   <h2><strong>1.介绍</strong></h2>    <p>在使用Android Studio开发的时候,大部分人都会使用一些插件来提高开发效率,比如:</p>    <ul>     <li> <p>ButterKnife 自动生成注解代码</p> </li>     <li> <p>PermissionsDispatcher 更方便的进行Android 6.0权限处理</p> </li>    </ul>    <p>像这样的插件还有很多很多,但我们不能一直停留在用的程度,这样太不符合程序猿的风格了,今天就让我们自己动手来写一个插件,当以后自己有好的想法的时候,也能写一个出色的插件给大家使用。</p>    <p>想到以前写系统原生dialog的时候还要写一大串代码,简直太麻烦,今天就用这个做例子,写一个插件来实现一键生成dialog代码。</p>    <p>注:本文只是为了熟悉Android Studio插件开发,所以用一个比较简单的例子来演示。</p>    <h2><strong>2.环境搭建</strong></h2>    <p>首先需要安装IntelliJ IDEA </p>    <p>安装完成后,运行起来是这个样子的:</p>    <p style="text-align: center;"><img src="https://simg.open-open.com/show/1ecfef0d1967e84f905e6f7460caa2f4.png"></p>    <p>IntelliJ IDEA</p>    <p>点击Create New Project新建一个Plugin项目,填写项目名称,选择位置就可以点击finish了。</p>    <p style="text-align: center;"><img src="https://simg.open-open.com/show/cb986893589c5cf2e548a9b593f6e5cb.png"></p>    <p>New Project</p>    <p>项目结构如下图所示:</p>    <p style="text-align: center;"><img src="https://simg.open-open.com/show/3f67c059efa2867bd70e715c1c44dc58.png"></p>    <p>项目结构</p>    <p>src目录下建包,和平时使用Android Studio的方式是一样的。</p>    <p>到这里,环境就搭建成功了(^-^)V</p>    <h2><strong>3.编写插件</strong></h2>    <h2><strong>新建Action</strong></h2>    <p>在新建的包下建一个Action类</p>    <p style="text-align: center;"><img src="https://simg.open-open.com/show/9db406585f5621bd1616a47acfb9fe5f.png"></p>    <p>New Action</p>    <p>然后填写一些信息</p>    <p style="text-align: center;"><img src="https://simg.open-open.com/show/fd93032ee669c7287e94020c5bd2298e.png"></p>    <p>填写信息</p>    <ul>     <li>ActionID:Action唯一的ID,一般的格式为:pluginName.ID</li>     <li>ClassName:类名</li>     <li>Name:插件最终显示在菜单上的名称</li>     <li>Description:对这个Action的描述信息</li>    </ul>    <p>然后往下,选择插件在菜单中的位置,这里选择的是Code菜单下第一的位置,然后定义一个快捷键。</p>    <p>点击OK,就创建了一个Action类了,</p>    <pre>  <code class="language-delphi">public class CreateDialogAction extends BaseGenerateAction {        public CreateDialogAction() {          super(null);      }        public CreateDialogAction(CodeInsightActionHandler handler) {          super(handler);      }        @Override      public void actionPerformed(AnActionEvent e) {        }  }</code></pre>    <p>注意把继承的AnAction改成BaseGenerateAction,下文需要用到BaseGenerateAction类中的相关方法。</p>    <h2><strong>代码实现</strong></h2>    <p>主要实现在类中自动生成代码,首先获取相关的操作类,已在代码中加入注释说明。</p>    <pre>  <code class="language-delphi">public class CreateDialogAction extends BaseGenerateAction {        public CreateDialogAction() {          super(null);      }        public CreateDialogAction(CodeInsightActionHandler handler) {          super(handler);      }        @Override      public void actionPerformed(AnActionEvent e) {            // 获取编辑器中的文件          Project project = e.getData(PlatformDataKeys.PROJECT);          Editor editor = e.getData(PlatformDataKeys.EDITOR);          PsiFile file = PsiUtilBase.getPsiFileInEditor(editor, project);            // 获取当前类          PsiClass targetClass = getTargetClass(editor, file);          // 获取元素操作的工厂类          PsiElementFactory factory = JavaPsiFacade.getElementFactory(project);            // 生成代码          new LayoutCreator(project, targetClass, factory, file).execute();      }  }</code></pre>    <p>生成代码,需要继承WriteCommandAction.Simple类,在run方法中写生成代码的逻辑,将生成dialog的代码存入StringBuilder,然后调用targetClass类中的add方法生成代码,最后再导入需要的类。</p>    <pre>  <code class="language-delphi">public class LayoutCreator extends WriteCommandAction.Simple {        private Project project;      private PsiFile file;      private PsiClass targetClass;      private PsiElementFactory factory;        public LayoutCreator(Project project, PsiClass targetClass, PsiElementFactory factory, PsiFile... files) {          super(project, files);          this.project = project;          this.file = files[0];          this.targetClass = targetClass;          this.factory = factory;      }        @Override      protected void run() throws Throwable {          // 将弹出dialog的方法写在StringBuilder里          StringBuilder dialog = new StringBuilder();          dialog.append("public void showDialog(){");          dialog.append("android.support.v7.app.AlertDialog.Builder builder = new AlertDialog.Builder(this);");          dialog.append("builder.setTitle(\"Title\")\n");          dialog.append(".setMessage(\"Dialog content\")\n");          dialog.append(".setPositiveButton(\"OK\", new android.content.DialogInterface.OnClickListener() {\n" +                  "@Override\n" +                  "public void onClick(DialogInterface dialog, int which) {\n" +                  "\t\n" +                  "}" +                  "})\n");          dialog.append(".setNegativeButton(\"Cancel\", new DialogInterface.OnClickListener() {\n" +                  "@Override\n" +                  "public void onClick(DialogInterface dialog, int which) {\n" +                  "\t\n" +                  "}" +                  "})\n");          dialog.append(".show();");          dialog.append("}");            // 将代码添加到当前类里          targetClass.add(factory.createMethodFromText(dialog.toString(), targetClass));            // 导入需要的类          JavaCodeStyleManager styleManager = JavaCodeStyleManager.getInstance(project);          styleManager.optimizeImports(file);          styleManager.shortenClassReferences(targetClass);      }  }</code></pre>    <p>点击编译器右上角的绿色Run按钮,会重新启动一个新的IntelliJ IDEA的界面,在这里创建一个Android工程,点击Code,会看到Android Dialog选项,看下效果:</p>    <p style="text-align: center;"><img src="https://simg.open-open.com/show/fb8184e853bc3f2fb4eab867a54cc941.gif"></p>    <p>Android Dialog</p>    <p>OK,到这里我们就成功的创建了一个插件,下面让我们来看看如何来部署插件。</p>    <h2><strong>4.部署插件</strong></h2>    <h2><strong>填写相关信息</strong></h2>    <p>打开项目中的plugin.xml文件,填写相关的信息,这些信息会展示在插件库中,如下图所示。</p>    <p style="text-align: center;"><img src="https://simg.open-open.com/show/c2433a483cfff9f5f292201fcf25f77e.png"></p>    <p>plugin</p>    <p>点击Bulid菜单下的Prepare Plugin按钮会在项目的根目录生成jar插件,如下图所示:</p>    <p style="text-align: center;"><img src="https://simg.open-open.com/show/6815bc57fbad796f5310da9383194e36.png"></p>    <p>生成插件</p>    <h2><strong>安装插件</strong></h2>    <p>打开Andorid Studio,选择File -> Settings -> Plugins -> Install plugin from disk,选择我们生成的jar然后重启即可,如下图所示,红框标记的部分就是我们刚才在plugin.xml文件中填写的信息:</p>    <p style="text-align: center;"><img src="https://simg.open-open.com/show/536d150bfbdff705841e6fa185d46cbc.png"></p>    <p>安装插件</p>    <h2><strong>发布插件</strong></h2>    <p>还可以把插件发布到仓库,让其他人也能使用,进入 JetBrains 官网,注册账号,提交插件jar包,填写相关信息,等待审核就可以了。</p>    <h2><strong>5.遇到的问题</strong></h2>    <p>安装插件的时候出现下面的报错,是因为IDEA中jdk的版本是1.8,而我的Android Studio中jdk的版本是1.7导致的,版本统一就好了。</p>    <pre>  <code class="language-delphi">Android Dialog threw an uncaught PluginException.</code></pre>    <h2><strong>6.总结</strong></h2>    <p>总结一下之前的步骤:</p>    <ul>     <li> <p>下载Intellij IDEA,新建一个Intellij Platform Plugin的项目(注意jdk版本的问题,最新的IDEA需要jdk 1.8版本)</p> </li>     <li> <p>在项目中新建一个Action,把继承的AnAction改成BaseGenerateActio</p> </li>     <li> <p>编写API,这个可以参考其他插件的写法</p> </li>     <li> <p>点击Bulid菜单下的Prepare Plugin按钮生成jar,这个jar就可以直接用来安装了</p> </li>    </ul>    <p> </p>    <p>来自:http://www.jianshu.com/p/c2a3e673188b</p>    <p> </p>