AndroidStudio 代碼生成插件Code Generator

前言

前幾天在做MVP遷移眶根,把項(xiàng)目舊代碼替換為使用MVP豺谈,給我的感覺(jué)就是重重復(fù)復(fù)的體力勞動(dòng)。MVP項(xiàng)目平常的開發(fā),要多建幾個(gè)類倘屹,多十幾個(gè)接口方法韩容。像一些TextView的setText,及View的Visibility唐瀑、Enable操作,寫的特?zé)┎宓缓蟀l(fā)現(xiàn)一個(gè)特好用的代碼生成插件哄辣,批量生成對(duì)應(yīng)的方法。

安裝

原Github地址
我的GitHub(入口放在倒數(shù)第一項(xiàng)赠尾,方便操作)

  1. 到Release頁(yè)力穗,下載Jar文件。
  2. AS中Plugins選擇從磁盤安裝气嫁。

使用

1.Alt + Insert 調(diào)出Generate窗口
2.選擇CodeGenerate
3.選擇需要生成的模板
4.選擇針對(duì)的變量
5.點(diǎn)擊ok生成


配置和自定義模板



類選擇框

成員變量選擇框
  • ui介紹
    左側(cè)是生成項(xiàng)当窗,右側(cè)是對(duì)應(yīng)的配置。
    右側(cè)Template是代碼生成模板寸宵,右側(cè)Member是成員變量過(guò)濾崖面。
    在右側(cè)Template中,可以增加成員變量過(guò)濾的窗口梯影,和類選擇窗口巫员。

  • 功能說(shuō)明
    最完整的一次過(guò)程:
    1 .彈出類選擇框,選擇操作的類
    2.彈出變量框甲棍,顯示在上面選中類里面過(guò)濾的變量
    3.選中需要所針對(duì)的變量简识,點(diǎn)擊ok,批量生成對(duì)應(yīng)變量的模板

  • 自定義
    模板使用的是velocity語(yǔ)言感猛,可以簡(jiǎn)單了解一下七扰。其實(shí)可以仿照給的原始模板ToString 、Getter and Setter修改陪白,進(jìn)行自己的自定義颈走。
    下面是作者提供的常用參數(shù),在自定義模板中會(huì)用到

 Tutorial for writing your templates

 1. First you need to know basic syntax of velocity[1].
 2. Then it is necessary to understand the variable that CodeGenerator provides
    and its inner structure for retrieving the information you need for generating code.
 3. Learn to use the utils provided so that you can ask for further information
    or reduce your workload.

 Variables Provided (Class Mode)
 -------------------------------
 Class mode means you want to create new classes(file).

 - ClassName: String     The name spcified by `Target Class Name`
 - PackageName: String   The package name specified by `Target Class Name`
 - class0: ClassEntry    The class that the action is triggered upon
   - raw: PsiClass
   - String packageName
   - importList: List<String>
   - fields: List<FieldEntry>
   - allFields: List<FieldEntry>
   - methods: List<MethodEntry>
   - allMethods: List<MethodEntry>
   - innerClasses: List<ClassEntry>
   - allInnerClasses: List<ClassEntry>
   - typeParamList:  List<String>
   - name: String
   - superName: String
   - superQualifiedName: String
   - qualifiedName: String
   - typeParams: int
   - hasSuper: boolean
   - deprecated: boolean
   - enum: boolean
   - exception: boolean
   - abstract: boolean
   - implementNames: String[]
   - isImplements(String): bool
   - isExtends(String): bool
   - matchName(String): bool

 - class1: ClassEntry    The first selected class, where `1` is the postfix
                         you specify in pipeline
   ...

 - MemberEntry (FieldEntry/MethodEntry common properties)
    - raw: PsiField(for field), PsiMethod(for method)
    - name: String
    - accessor: String
    - array: boolean
    - nestedArray: boolean
    - collection: boolean
    - map: boolean
    - primitive: boolean
    - string: boolean
    - primitiveArray: boolean
    - objectArray: boolean
    - numeric: boolean
    - object: boolean
    - date: boolean
    - set: boolean
    - list: boolean
    - stringArray: boolean
    - calendar: boolean
    - typeName: String
    - typeQualifiedName: String     //包含路徑
    - type: String
    - boolean: boolean
    - long: boolean
    - float: boolean
    - double: boolean
    - void: boolean
    - notNull: boolean
    - char: boolean
    - byte: boolean
    - short: boolean
    - modifierStatic: boolean
    - modifierPublic: boolean
    - modifierProtected: boolean
    - modifierPackageLocal: boolean
    - modifierPrivate: boolean
    - modifierFinal: boolean

 - FieldEntry
   - constant: boolean
   - modifierTransient: boolean
   - modifierVolatile: boolean
   - enum: boolean
   - matchName(String): bool

 - MethodEntry
   - methodName: String
   - fieldName: String
   - modifierAbstract: boolean
   - modifierSynchronzied: boolean
   - modifierSynchronized: boolean
   - returnTypeVoid: boolean
   - getter: boolean
   - deprecated: boolean
   - matchName(String): bool

 Variables for Body Mode
 -----------------------
 - class0: ClassEntry         The current class
 - fields: List<FieldEntry>   All selected fields
 - methods: List<MethodEntry> All selected methods
 - members: List<MemberEntry> selected fields+methods
 - parentMethod: MethodEntry  The nearest method that surround the current cursor

 Utilities
 ---------
 - settings: CodeStyleSettings settings of code style
 - project: Project            The project instance, normally used by Psi related utilities
 - helper: GenerationHelper
 - StringUtil: Class
 - NameUtil: Class
 - PsiShortNamesCache: Class   utility to search classes
 - PsiJavaPsiFacade: Class     Java specific utility to search classes
 - GlobalSearchScope: Class    class to create search scopes, used by above utilities
 - EntryFactory: Class         EntryFactory.of(...) to turn PsiXXX to XXXEntry.

 Other feature
 -------------
 - Auto import.      If the generated code contains full qualified name, Code Generator will try to
                     import the packages automatically and shorten the name.
                     For example `java.util.List<>` -> `List<>`

 References
 ----------
 - Velocity syntax: http://velocity.apache.org/engine/1.7/user-guide.html

另外一個(gè)比較需要的方法咱士,就是查找集成指定的類的 成員變量疫鹊,比如我要給找出所有繼承了View的成員變量,然后統(tǒng)一生成setVisibilityXXX()方法方法司致。因?yàn)樵贛VP時(shí)候拆吆,經(jīng)常用到這個(gè),還有TextView的setTextXXX()脂矫,都是只有View和TextView才擁有的方法枣耀。下面這個(gè)是在Member選項(xiàng)卡中的代碼,作用是過(guò)濾所有繼承android.view.View這個(gè)類的成員變量。

 Specified Class Type Filter
 -------------
 #set($typeTarget = "android.view.View")

 #set($availableMembers = $class0.members)
 #set($javaPsiFacade = $JavaPsiFacade.getInstance($project))
 #set($global = $GlobalSearchScope.allScope($project))
 #set($xtype = $javaPsiFacade.findClass($typeTarget, $global))

 #set($availableMembers = [])
 #set($methodNames = [])

 #foreach($member in $class0.members)
     #set($memberType = $member.type.split("&lt;").get(0))
     #set($type = $javaPsiFacade.findClass($memberType, $global))
     #if ($type.qualifiedName == $typeTarget || $type.isInheritor($xtype, true))
         $availableMembers.add($member)
     #end
 #end

我的模板

之前對(duì)項(xiàng)目進(jìn)行MVP重構(gòu)時(shí)候捞奕,很煩那些setText()牺堰、setEnabled()、setVisibility()之類的颅围,所以找到了這個(gè)控件伟葫,然后簡(jiǎn)單下學(xué)了一下自定義,自己寫了模板院促,需要的可以直接把文件拿下來(lái)導(dǎo)入使用筏养。根目錄下code-generator-my-setting.xml文件。
另外常拓,因?yàn)樵寮肟谖恢貌⒉皇窃诘箶?shù)第一項(xiàng)渐溶,強(qiáng)迫癥的自己為了方便使用,把源碼拿下來(lái)重新配置了一下弄抬,入口固定在倒數(shù)第一項(xiàng)茎辐,很方便,感興趣掂恕,可以下項(xiàng)目中的jar(重新編譯之后的插件)導(dǎo)入使用拖陆。
GitHub

總結(jié)

在生成代碼方面,該插件的功能絕對(duì)是最強(qiáng)大的懊亡,最靈活慕蔚,完全自定義,還可以選擇指定類斋配。只要配置了一次模板孔飒,就可以一勞永逸。
唯一的缺憾就是不支持文件生成艰争,否則MVP模式的文件也無(wú)需手動(dòng)創(chuàng)建了坏瞄。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市甩卓,隨后出現(xiàn)的幾起案子鸠匀,更是在濱河造成了極大的恐慌,老刑警劉巖逾柿,帶你破解...
    沈念sama閱讀 217,542評(píng)論 6 504
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件缀棍,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡机错,警方通過(guò)查閱死者的電腦和手機(jī)爬范,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,822評(píng)論 3 394
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)弱匪,“玉大人青瀑,你說(shuō)我怎么就攤上這事。” “怎么了斥难?”我有些...
    開封第一講書人閱讀 163,912評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵枝嘶,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我哑诊,道長(zhǎng)群扶,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,449評(píng)論 1 293
  • 正文 為了忘掉前任镀裤,我火速辦了婚禮竞阐,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘淹禾。我一直安慰自己,他們只是感情好茴扁,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,500評(píng)論 6 392
  • 文/花漫 我一把揭開白布铃岔。 她就那樣靜靜地躺著,像睡著了一般峭火。 火紅的嫁衣襯著肌膚如雪毁习。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,370評(píng)論 1 302
  • 那天卖丸,我揣著相機(jī)與錄音纺且,去河邊找鬼。 笑死稍浆,一個(gè)胖子當(dāng)著我的面吹牛载碌,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播衅枫,決...
    沈念sama閱讀 40,193評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼嫁艇,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了弦撩?” 一聲冷哼從身側(cè)響起步咪,我...
    開封第一講書人閱讀 39,074評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎益楼,沒(méi)想到半個(gè)月后猾漫,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,505評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡感凤,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,722評(píng)論 3 335
  • 正文 我和宋清朗相戀三年悯周,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片陪竿。...
    茶點(diǎn)故事閱讀 39,841評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡队橙,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情捐康,我是刑警寧澤仇矾,帶...
    沈念sama閱讀 35,569評(píng)論 5 345
  • 正文 年R本政府宣布,位于F島的核電站解总,受9級(jí)特大地震影響贮匕,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜花枫,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,168評(píng)論 3 328
  • 文/蒙蒙 一刻盐、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧劳翰,春花似錦敦锌、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,783評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至生均,卻和暖如春听想,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背马胧。 一陣腳步聲響...
    開封第一講書人閱讀 32,918評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工汉买, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人佩脊。 一個(gè)月前我還...
    沈念sama閱讀 47,962評(píng)論 2 370
  • 正文 我出身青樓蛙粘,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親威彰。 傳聞我的和親對(duì)象是個(gè)殘疾皇子组题,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,781評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容

  • Android 自定義View的各種姿勢(shì)1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,116評(píng)論 25 707
  • 文/冰焰free 陳小希喜歡江辰崔列,所有人都知道。不論是她最好的閨蜜林靜曉旺遮,還是喜歡著她的吳柏松赵讯,或者是經(jīng)常和他們廝...
    冰焰free閱讀 690評(píng)論 0 1
  • 自從媽媽從2017年6月份確診為腸癌,做完手術(shù)后醫(yī)生說(shuō):“出于安全考慮耿眉,需要化療”預(yù)防…… 術(shù)后休息了半個(gè)月左右就...
    蠢萌貓咪閱讀 469評(píng)論 0 0
  • 這個(gè)周末就是母親節(jié)了边翼,今天放學(xué)去接娃,一見(jiàn)到我就急著把他做的手工花送給我 鸣剪,說(shuō)祝我節(jié)日快樂(lè)!呵呵组底,好像是第一次收...
    云沐媽媽閱讀 216評(píng)論 0 0
  • [HTML && CSS] 1.Doctype嚴(yán)格模式與混雜模式-如何觸發(fā)這兩種模式丈积,區(qū)分它們有何意義? 嚴(yán)格模式...
    裝在殼子里的刺猬閱讀 344評(píng)論 0 1