Android Studio 插件开发总结

前言

在日常开发中,绝大多数的工作都是开发Creator,创建UI,初始化UI,绑定数据,重复的创建ViewHolder类,findViewById代码,能不能将这些重复工作自动化呢,在看了android-butterknife-zelezny之后,我找到了灵感,使用As插件就能完成这些琐碎重复的事情啊。

API说明

Logger

和Android的Log类非常相似,包含info函数,error函数,warn函数等等

BaseGenerateAction

  • isValidForClass
@Overrideprotected boolean isValidForClass(PsiClass targetClass) {   
     return super.isValidForClass(targetClass);
}

用户调用该插件的时候,光标所在的类,该函数主要是让开发者验证操作

  • isValidForFile
// project 即为当前的工程
// editor 没有什么用
// file: 当前操作的文件
@Override
protected boolean isValidForFile(@NotNull Project project, @NotNull Editor editor, @NotNull PsiFile file) {   
    return super.isValidForFile(project, editor, file);
}

用户调用该插件的时候,光标所在的类,该函数主要是让开发者验证操作

  • actionPerformed
    响应用户的操作

Psi文件

PsiElement

类似与xml中的Element概念,AS将所有的代码语法都进行了抽象化,PsiElement是下面的PsiClass,PsiCodeBlock等等的父类

PsiField

代表类中的字段属性

PsiClass

代表一个类

PsiFile

代表一个文件

PsiCodeBlock

比如有一个函数,他的函数体就是PsiCodeBlock

PsiStatement

函数中的每一行代码就是一个PsiStatement

PsiMethod

代表一个方法

PsiElementFactory

一个用来创建上述PsiElement的工厂

BaseGenerateAction

继承自AnAction,提供了isValidForClass, isValidForFile , actionPerformed等函数

FAQ

1. 在哪里可以看到插件开发所用到的api的文档啊

2. 导入已有的插件工程

导入plugin工程之后,有可能会无法编译,很多类都找不到,其实只要设置该Module的sdk就可以了,new sdk,选择idea安装目录 ,具体的可以参照这篇文章

3. 如何创建一个新的plugin工程

官方文档

Paste_Image.png

4. 如何将插件编译成jar包提供给别人安装

使用『prepare。。。。』就可以将plugin工程打成jar包,jar包的位置在工程的主目录下, 然后在Android studio中选择install from disk安装就可以了


Paste_Image.png
Paste_Image.png

5. 如何打印日志,查看日志

  1. 创建log对象
    protected static final Logger log = Logger.getInstance(xxx.class);
  2. 点击『show
    log in finder』,会打开一个目录,里面有很多的log文件,你在plugin工程中使用Logger.info打印的日志都会存储在该log文件中,打开即可
Paste_Image.png

6. 如何配置Action

什么是Action?
  • Action就是插件配置的,用户可以选择的操作
  • Action是一个插件的入口,类似于Android中的MainActivity

在下图的plugin.xml中,可以配置Action


Paste_Image.png

Incorrect statement 异常

记住,在AS中 ,Statement仅仅代表一行代码,可能表述不准确,举个例子

int x = 10; 这是一个PsiStatement
int x = 10;
int y = 10;
这就不是一个PsiStatement了

参考

  1. Intellij IDEA插件开发入门
  2. 初试IDEA插件开发
  3. 自己动手写IDEA plugin – PubEditor (1) Hello, world
  4. IntelliJ Platform SDK Documentation
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,830评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,992评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,875评论 0 331
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,837评论 1 271
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,734评论 5 360
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,091评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,550评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,217评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,368评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,298评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,350评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,027评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,623评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,706评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,940评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,349评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,936评论 2 341

推荐阅读更多精彩内容