我所知道的偷懒方式(二)

作者: ___刘辉良 | 来源:发表于2019-12-30 16:13 被阅读0次

    前言

    在现今的软件开发过程中,软件开发人员将更多的精力投入在了重复的相似劳动中。特别是在如今特别流行的 MVC 架构模式中,软件各个层次的功能更加独立,同时代码的相似度也更加高。所以我们需要寻找一种来减少软件开发人员重复劳动的方法,让程序员将更多的精力放在业务逻辑以及其他更加具有创造力的工作上。

    Android 的一种"偷懒"

    live templates

    当我们在项目的开发中,会发现很多相识的代码在java文件中会不断的出现。就比如说我们要启动一个Activity的时候,我们可以写

         public static void start(Context context) {
           Intent starter = new Intent(context, MainActivity.class);
           context.startActivity(starter);
       }
    

    这样的代码会存在于每一个需要被启动的Activity中,我们如果每个Activity都去写这么多行的代码,工作量就会很大。所以我们可以借助android studiolive templates来完成这个重复的劳动力。

    录制_2019_12_27_17_47_16_470.gif

    可以看到,我们借助了Android Studio自带的live templates来完成了我们上述说的代码。Android Studio里面还带有很多模板。比如说ToastLog。具体可以查看(Settings/Editor/Live Templates)

    除了Android Studio自带的一些模板,我们还可以自定义一些模板。

    录制_2019_12_30_11_36_36_691.gif

    上述我们自定义了一个带有注释的模板,用来实现类的注释,在定义模板的时候,你需要选择模板的类型java和模板中的一些函数变量。这样的话,你就可以自定义出想要的模板类型了。更多模板代码,可查看下面这个链接

    https://github.com/kirtan403/android-studio-live-templates

    IDEA 插件

    我们在MVP的开发中,需要创建很多文件,DataSourceRepositoryDataSourceImpl。我们希望在创建一个文件的时候,就已经确定了类的结构和继承结构。如我们希望创建一个UserDataSource的类的结构是下图

    image.png

    这个时候,live templates明显已经无法满足我们的功能。我们希望在创建java类的时候,就可以将所需要的全部类创建好。这个时候IDEA插件就可以大展身手了。在实现之前,我们先看下最终我们需要完成的效果。

    录制_2019_12_30_15_21_18_638.gif

    可以看到,当我们创建User的时候,所有的DataSource都帮我们补齐了,而且继承结构也已经完成了。这样你就可以愉快的编写逻辑代码了。

    在介绍IDEA插件开发前,我们先需要下载IntelliJ IDEA来进插件开发。然后创建一个IntelliJ PlatForm Plugin的项目。

    image.png

    创建之后的项目结构,可以看到一个plugin.xml这个是对你的插件的描述。src是你插件的核心代码。因为我们是要创建的是java的模板代码。所以我们需要自定义一个类继承自JavaCreateTemplateInPackageAction。然后在onCreate里面完成相关的模板代码。

     @Nullable
        @Override
        protected PsiClass doCreate(PsiDirectory dir, String className, String s1) throws IncorrectOperationException {
            PsiClass result = JavaDirectoryService.getInstance().createClass(dir, className + "DataSource", DATA_SOURCE_TEMPLATE_NAME);
            PsiClass result2 = JavaDirectoryService.getInstance().createClass(dir, className + "LocalDataSource", LOCAL_DATA_SOURCE_TEMPLATE_NAME);
            PsiClass result3 = JavaDirectoryService.getInstance().createClass(dir, className + "RemoteDataSource", REMOTE_DATA_SOURCE_TEMPLATE_NAME);
            PsiClass result4 = JavaDirectoryService.getInstance().createClass(dir, className + "Repository", Repository_TEMPLATE_NAME);
            replaceClassName(className, result2);
            replaceClassName(className, result3);
            replaceClassName(className, result4);
            return result;
        }
    

    完成这些逻辑之后,记得把你的类配置到plugin.xml中。这样IDEA才能识别。

     <actions>
            <action id="CreateDataSourceAction" class="com.capital.datasource.CreateDataSourceAction"
                text="DataResource" description="Create an DataSource class">
                <add-to-group group-id="NewGroup" anchor="first" />
            </action>
    
            <action id="CreateContractAction" class="com.capital.datasource.CreateContractAction"
                text="Contract" description="Create an Contract class">
                <add-to-group group-id="NewGroup" anchor="first" />
            </action>
        </actions>
    
    

    这里对插件开发的详细过程不做具体的解释,但是还是要上一张如何断点的图,因为很多生命周期的调用方法。都是通过断点知道的。所以下一个断点,就知道该方法在什么时候被调用了。

    录制_2019_12_30_15_36_27_14.gif

    稍等一会,就会重新启动一个IDEA。这样你就可以愉快的调试了。

    最后,就是将开发好的插件进行打包,然后导入到Android Studio中使用了。

    录制_2019_12_30_15_48_19_527.gif

    当然,上述只是完成了DataSource的插件模板,你还可以定义Presenter插件模板。只要你觉得可行的,都可以做一下尝试。来解放你的双手!上述的具体代码

    https://github.com/BelongsH/IDEA-Plugin-Android

    Android Studio 工程模板

    当项目在组件化的工程中,会发现每创建一个组件,都需要创建各个包目录、拷贝gradle文件。这样的操作非常费时。这里我们借助Android Studio创建Activity的模板来改建我们创建组件的过程。还是先看下最终的效果

    录制_2019_12_30_16_02_03_440.gif

    可以看到,当我们创建一个Module的时候,文件夹已经按照我的想法来进行命名,而且build.gradle也已经安装自己的方式创建好了。

    在创建Android Studio 的时候,需要先备份一份旧的!!!!

    为了怕改了模板之后,创建系统模板出现问题,在创建自己的模板之前,一定要先备份旧的。能够回退!!!

    我们找到android studio的安装目录,然后进去plugins\android\lib\templates\gradle-projects文件夹中。然后复制一份魔改一下。template.xml里面主要对这个模板进行描述和全局的配置。最主要还是recipe.xml.ftl里面包含了是否创建哪个文件夹和合拼哪个文件.

    <?xml version="1.0"?>
    
    <recipe>
        <mkdir at="${escapeXmlAttribute(projectOut)}/libs" />
        <mkdir at="${escapeXmlAttribute(resOut)}/anim" />
        <mkdir at="${escapeXmlAttribute(resOut)}/drawable" />
        <mkdir at="${escapeXmlAttribute(resOut)}/drawable-xhdpi" />
        <mkdir at="${escapeXmlAttribute(resOut)}/drawable-xxhdpi" />
        <mkdir at="${escapeXmlAttribute(resOut)}/drawable-xxxhdpi" />
      
        <mkdir at="${escapeXmlAttribute(resOut)}/layout" />
        <mkdir at="${escapeXmlAttribute(resOut)}/values" />
        
        
        
        <mkdir at="${projectOut}/src/main/java/${slashedPackageName(packageName)}/activity" />
        <mkdir at="${projectOut}/src/main/java/${slashedPackageName(packageName)}/fragment" />
        <mkdir at="${projectOut}/src/main/java/${slashedPackageName(packageName)}/item" />
        <mkdir at="${projectOut}/src/main/java/${slashedPackageName(packageName)}/contract" />
        <mkdir at="${projectOut}/src/main/java/${slashedPackageName(packageName)}/contract/impl" />
        <mkdir at="${projectOut}/src/main/java/${slashedPackageName(packageName)}/data/local" />
        <mkdir at="${projectOut}/src/main/java/${slashedPackageName(packageName)}/data/remote" />
        <mkdir at="${projectOut}/src/main/java/${slashedPackageName(packageName)}/data/model" />
        <mkdir at="${projectOut}/src/main/java/${slashedPackageName(packageName)}/data/repository" />
        <mkdir at="${projectOut}/src/main/java/${slashedPackageName(packageName)}/data/source" />
        <mkdir at="${projectOut}/src/main/java/${slashedPackageName(packageName)}/provider" />
    
    
        <merge from="root/settings.gradle.ftl" to="${escapeXmlAttribute(topOut)}/settings.gradle" />
       
        
        <instantiate from="root/AndroidManifest.xml.ftl"  to="${escapeXmlAttribute(manifestOut)}/AndroidManifest.xml" />  
        <instantiate from="root/src/app_package/Api.java.ftl" to="${projectOut}/src/main/java/${slashedPackageName(packageName)}/data/Api.java" />
        <instantiate from="root/src/app_package/RouterApi.java.ftl" to="${projectOut}/src/main/java/${slashedPackageName(packageName)}/RouterApi.java"/>
        
        <instantiate  from="root/res/values/strings.xml.ftl"
                      to="${escapeXmlAttribute(resOut)}/values/strings.xml" />
        <instantiate  from="root/res/values/dimens.xml.ftl" 
                      to="${escapeXmlAttribute(resOut)}/values/dimens.xml" />
        <instantiate  from="root/res/values/styles.xml.ftl"
                      to="${escapeXmlAttribute(resOut)}/values/styles.xml" />
        <copy      from="root/res/values/colors.xml" to="${escapeXmlAttribute(resOut)}/values/colors.xml" />
        <copy       from="root/project_build_gradle.gradle" to="${escapeXmlAttribute(projectOut)}/build.gradle" />
    </recipe>   
    
    
    

    具体代码

    https://github.com/BelongsH/IDEA-Plugin-Android

    相关链接:

    https://www.jianshu.com/p/13c1c0d6a1e7
    https://www.jianshu.com/p/c9dd2a8101c8

    相关文章

      网友评论

        本文标题:我所知道的偷懒方式(二)

        本文链接:https://www.haomeiwen.com/subject/hremoctx.html