Skip to content

Latest commit

 

History

History
170 lines (124 loc) · 6.64 KB

README.md

File metadata and controls

170 lines (124 loc) · 6.64 KB
Raw

2018年05月10日14:23:12

ThinkSNS Plus Android Dev Doc

简介

本文档旨在帮助开发者快速理解并基于 ThinkSNS Plus Android 端的开发，为二次开发提高效率。

整个项目相关的决策工作安排等记录在thinksns-plus-document.

整个项目代码风格都遵守智艺创想移动端开发代码风格指南

注意： 需要二次开发的，请在开发分支develop分支上面进行修改，不要使用master分支直接修改，master分支将用于更新ts+最新代码，如需要新的代码，请自行将master分支代码合并到develop分支上。从 1.6 版本开始，会同步推送大版本更新与修复，如: 1.6,1.7... ，便于用户选取不同的版本更新迭代，大版本将对应服务器的版本，请同步更新。

工程基础配置说明

该工程使用 java 语言编写,部分功能将会接入 kotlin.支持 Android 4.3 (api 18) 及以上系统.

当前 IDE 为 Android Studio 3.1 编辑器 ，建议使用最新的 IDE,便于更快的构建.

Gradle 版本

   distributionUrl=https\://services.gradle.org/distributions/gradle-4.1-all.zip

    dependencies {
        classpath 'com.android.tools.build:gradle:3.3.0'
    }

gradle 全局配置

注： 所有三方依赖包统一写入config.gradle，gradle配置文件config.gradle,需要在主项目的buid.grale中进行声明 apply from："config.gralde"

Git 忽略文件说明

本工程忽略文件配置位于主工程下 .gitignore文件，可手动修改配置内容

代码混淆说明

开启代码混淆和混淆规则 app 的 builde.gradle 的文件下，buildTypes 节点添加 release 节点， minifyEnabled 属性表示是否开启混淆，proguardFiles 表示混淆依赖的文件，具体开启方法如下：

apply plugin: 'com.android.application'

android {
   ...
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
    ...
}

混淆配置说明

 # 指定代码的压缩级别
-optimizationpasses 5
 # 是否使用大小写混合
-dontusemixedcaseclassnames
 # 是否混淆第三方jar
-dontskipnonpubliclibraryclasses
 # 混淆时是否做预校验
-dontpreverify
 # 混淆时是否记录日志
-verbose
 # 混淆时所采用的算法
-optimizations !code/simplification/arithmetic,!field/*,!class/merging/*
 # 保持哪些类不被混淆
-keep public class * extends android.content.ContentProvider
 # 保持哪些类不被混淆
-keep public class * extends android.app.backup.BackupAgentHelper
 # 保持哪些类不被混淆
-keep public class * extends android.preference.Preference
 # 保持哪些类不被混淆
-keep public class com.android.vending.licensing.ILicensingService
 # 保持 native 方法不被混淆
-keepclasseswithmembernames class * {
    native <methods>;
}
 # 保持自定义控件类不被混淆
-keepclasseswithmembers class * {
    public (android.content.Context, android.util.AttributeSet);
}
 # 保持自定义控件类不被混淆
-keepclasseswithmembers class * {
    public (android.content.Context, android.util.AttributeSet, int);
}
 # 保持自定义控件类不被混淆
-keepclassmembers class * extends android.app.Activity {
   public void *(android.view.View);
}
 # 保持枚举 enum 类不被混淆
-keepclassmembers enum * {
    public static **[] values();
    public static ** valueOf(java.lang.String);
}
 # 保持 Parcelable 不被混淆
-keep class * implements android.os.Parcelable {
  public static final android.os.Parcelable$Creator *;
}

注意: 使用时请参考 app/proguard-rules.pro

项目安装、打包、签名说明

项目x86支持说明

文档位置说明

本工程文档统一记录在ThinksnsPlus/document文件夹下.

分支使用说明

分支命名方式以git工作流为准

示例:

master ( 主分支 )
develop (开发分支 )
feature/add_image  ( 特性分支 )
feature/add_image_jungle68 ( 个人开发可以加上作者 )
hotfix/pay_fail ( 修复分支 )

注意:

作者分支和作者分支的子分支按照作者意愿合并,由作者分支作者负责管理.

因为远端仓库存储了大量的主版本和子版本分支,为了减少不必要的更新和下载操作,所以作者分支不允许推送到远端.

为了方便后续使用自动化工具筛检commit内容,规定每次提交和issues相关的代码时,使用统一格式: 在提交信息末尾空一格,空一格后记录下commit类型,然后再在英文符号的括号内填写issues code.默认的 commit 类型为: 代码,文档以及测试

   示例代码:(#9527) code 提交信息    示例代码:(#9527) doc 提交信息    示例代码:(#12 #30 #78) test 提交了测试信息

框架选型

why choose this?

框架 劣势 优势
MVP 接口过多 1.官方推荐；

2.代码结构清晰;

3.代码解耦
Retrofit 1.Square提供，质量高，不断维护更新；

2.易扩展，提供不同的Converter、Intercept等实现（也可以自定义），同时提供RxJava支持(返回Observable对象)，配合Jackson(或者Gson)和RxJava使用；

3.网络请求简洁明了
Dagger2 1.google官方推荐，配合mvp;

2.依赖注入，解耦代码；

3.简化对象的创建以及管理
Rx 1.使用干净的输入/输出函数;

2.减少代码行数；

3.异步的错误处理；

4.便于线程操作

工程结构

请查看二次开发文档