Android Config Plugin

Provide default config for android

License

License

Categories

Categories

Gradle Build Tools config Application Layer Libs Configuration
GroupId

GroupId

cn.yerl.gradle
ArtifactId

ArtifactId

android-config-plugin
Last Version

Last Version

1.0.2
Release Date

Release Date

Type

Type

jar
Description

Description

Android Config Plugin
Provide default config for android
Project URL

Project URL

https://github.com/alan-yeh/gradle-plugins
Source Code Management

Source Code Management

https://github.com/alan-yeh/gradle-plugins

Download android-config-plugin

How to add to project

<!-- https://jarcasting.com/artifacts/cn.yerl.gradle/android-config-plugin/ -->
<dependency>
    <groupId>cn.yerl.gradle</groupId>
    <artifactId>android-config-plugin</artifactId>
    <version>1.0.2</version>
</dependency>
// https://jarcasting.com/artifacts/cn.yerl.gradle/android-config-plugin/
implementation 'cn.yerl.gradle:android-config-plugin:1.0.2'
// https://jarcasting.com/artifacts/cn.yerl.gradle/android-config-plugin/
implementation ("cn.yerl.gradle:android-config-plugin:1.0.2")
'cn.yerl.gradle:android-config-plugin:jar:1.0.2'
<dependency org="cn.yerl.gradle" name="android-config-plugin" rev="1.0.2">
  <artifact name="android-config-plugin" type="jar" />
</dependency>
@Grapes(
@Grab(group='cn.yerl.gradle', module='android-config-plugin', version='1.0.2')
)
libraryDependencies += "cn.yerl.gradle" % "android-config-plugin" % "1.0.2"
[cn.yerl.gradle/android-config-plugin "1.0.2"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

Gradle Plugins

Profile plugin

  Profile plugin用于解决Java Web开发中的多环境、多现场配置难题。Profile plugin使用起来比较简单,如下面的例子:

buildscript {
    repositories {
        mavenCentral()
    }

    dependencies {
        classpath 'cn.yerl.gradle:profile-plugin:+'
    }
}

// 多现场配置
apply plugin: 'profile'

profile {
    // 切换环境,使用home
    flavor 'test'
    // BuildProfile类的包名
    classPackage 'cn.yerl.example'
    // buildprofile.properties的文件名
    profileFileName 'buildprofile'

    // 默认配置
    defaultProfile {
        // 正式环境的数据库配置
        propertyField 'jdbc.driver', 'oracle.jdbc.driver.OracleDriver'
        propertyField 'jdbc.url', 'jdbc:oracle:thin:@10.0.1.3:1521:orcl'
        propertyField 'jdbc.username', 'db'
        propertyField 'jdbc.password', 'xxxxxxxx'
        propertyField 'jdbc.initialSize', '2'
        propertyField 'jdbc.maxActive', '2'
        
        classField 'String', 'INDEX_FILE', '"default"'

        propertyField 'hello', 'Hello From Default'
    }
    home {
        // 家里的数据库配置
        propertyField 'jdbc.url', 'jdbc:oracle:thin:@192.168.0.112:1521:orcl'
        propertyField 'jdbc.username', 'home_db'
        propertyField 'jdbc.password', 'home'
        
        classField 'String', 'INDEX_FILE', '"home"'

        // 在家里开发用mac,路径采用mac的路径写法
        propertyField "hello", 'Hello From Home'
    }
    test {
        // 测试环境的数据库配置
        propertyField 'jdbc.username', 'test_db'
        propertyField 'jdbc.password', 'test'
        
        // 测试环境的路径在D盘
        classField 'String', 'INDEX_FILE', '"test"'
        propertyField 'hello', 'Hello From Test'
    }
}
  • propertyField: 写入配置到buildprofile.properties文件
  • classField: 写入配置到BuildProfile类
  • flavor: 切换环境, 如果没有写, 则默认是defaultProfile
  • defaultProfile: 默认配置
  • home/test: 演示的环境配置, 如果想修改或新增其它的配置, 可以随意起名字, 格式按着home/test写就行了。
  • classPackage: 生成的BuildProfile类的package
  • propertiesFileName: 生成的buildprofile.properties文件名

  使用插件后,项目的目录会发生改变,新增profile目录:

  同时,profile目录里会根据flavor配置而生成类(BuildProfile)和properties(buildprofile.properties),在java代码中中,可以之间使用用这两个文件。

@Controller
public class IndexController {
    @GetMapping("/index")
    public ModelAndView index() throws IOException {
        // 读取buildprofile.properties的配置
        Map<String, Object> model = new HashMap<>();
        model.put("hello", BuildProfile.get("hello"));

        // 直接使用BuildProfile类就可以了
        return new ModelAndView(BuildProfile.INDEX_FILE, model);
    }
}

  Spring里面经常在context里面配置数据库连接等,那么可以像下面这样配合Profile plugin做多现场配置。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:tx="http://www.springframework.org/schema/tx"
       xsi:schemaLocation="
        http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/tx
        http://www.springframework.org/schema/tx/spring-tx.xsd">

    <!-- spring的属性加载器,加载properties文件中的属性 -->
    <bean id="placeholderConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
        <property name="location">
            <value>classpath:buildprofile.properties</value>
        </property>
        <property name="fileEncoding" value="utf-8" />
    </bean>
    <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource"
          destroy-method="close">
        <property name="driverClassName">
            <value>${jdbc.driver}</value>
        </property>
        <property name="url">
            <value>${jdbc.url}</value>
        </property>
        <property name="username">
            <value>${jdbc.username}</value>
        </property>
        <property name="password">
            <value>${jdbc.password}</value>
        </property>
        <property name="initialSize">
            <value>${jdbc.initialSize}</value>
        </property>
        <property name="maxActive">
            <value>${jdbc.maxActive}</value>
        </property>
    </bean>
    <!-- 省略以下的配置 -->
    ....
</beans>

Nexus Plugin

  Nexus Plugin用于将jar包等发布到nexus管理器中。当前Nexus Plugin已兼容Android Studio。

buildscript {
    repositories {
        mavenCentral()
    }

    dependencies {
        classpath 'cn.yerl.gradle:nexus-plugin:+'
    }
}

apply plugin: 'nexus'

nexus {
    repository {
        username project.ext["nexus.username"]
        password project.ext["nexus.password"]
        // release 'your_nexus_release_repo_url'
        // snapshot 'your_nexus_snapshot_repo_url'
    }

    signatory {
        keyId project.ext["signatory.keyId"]
        password project.ext["signatory.password"]
    }

    pom {
        name 'Profile Plugin'
        description 'Profile configuration for Java Web Project'
        url 'https://github.com/alan-yeh/gradle-plugins'

        scm {
            url 'https://github.com/alan-yeh/gradle-plugins'
            connection 'scm:https://github.com/alan-yeh/gradle-plugins.git'
            developerConnection 'scm:[email protected]:alan-yeh/gradle-plugins.git'
        }

        licenses {
            license {
                name 'The Apache Software License, Version 2.0'
                url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
            }
        }

        developers {
            developer {
                name 'Alan Yeh'
                email '[email protected]'
            }
        }
    }
}

Versions

Version
1.0.2
1.0.1
1.0.0