Skip to content

Latest commit

 

History

History
126 lines (100 loc) · 3.2 KB

README.md

File metadata and controls

126 lines (100 loc) · 3.2 KB

<<<<<<< HEAD

coderiver-android

没人开始搭建框架吗？

=======

coderiver

致力于打造全平台全栈精品开源项目

技术栈

本项目Android端的开发宗旨是“不断学习，不断挖坑，不断优化”

所以经B组成员讨论，Android端采用当前最新最热的框架进行开发，

模块化开发 + Kotlin + MVVM + RxJava + Glide + ARouter + Dagger2

  • Kotlin ：2017年Kotlin 成为 Android 官方开发语言，而Kotlin又以简洁、安全、实用高效著称，本着学习进步的态度，Kotlin成为本项目开发的不二之选。
  • MVVM ：低耦合、可重用、双向绑定
  • RxJava ： 可以让异步操作更加简洁
  • Glide ：图片加载
  • ARouter ： 一个用于帮助 Android App 进行组件化改造的框架 —— 支持模块间的路由、通信、解耦
  • Dagger2 ：Android最棒的依赖注入框架
  • 模块化开发 ：解耦，各模块可独立运行，加快编译时间。

项目结构：

android 项目本身支持module开发，因此将项目分为 lib module和framework module。 lib module为最底层是必不可少的module，包含帐号管理、登录登出等关键信息。结构如下：
               app（启动CodeRiver，本身不做任何逻辑）
                                |
                     CodeRiver（组合各模块功能，形成整个应用）
                                |
             功能module1、功能module2  （各功能模块） 
                                |
                    CodeRiverSdk（核心api及框架 roomdb,rxjava,okhttp初始化及封装）
还有 tools module 一些通用工具方法，uikit通用的View及引用的第三方ui框架等

api设计：

CodeRiverSdk  module  api设计
   CodeRiverClient 
      init 初始化 ，初始化完成功后，若上一次用户已经登录，将执行离线登录。
      registerServer 注册常驻内存的服务类
CodeRiver  module  api设计
   CodeRiverInitHelper
      init 初始化CodeRiver
      goHome 跳转到主页面
app module 调CodeRiverInitHelper.init开始整个应用的使用

文件目录

清晰的文件树是项目结构化关键的一部分，请描述当前的结构

e.g.

.
├── client
│   ├── components
│   ├── constant
│   ├── container
│   ├── public
│   ├── redux
│   │   ├── actions
│   │   ├── reducers
│   │   └── store
│   ├── resources
│   │   └── less
│   ├── routes
│   └── util
├── tmp
│   └── dll
└── tools
    ├── commands
    ├── configs
    │   ├── dev
    │   └── prod
    └── utils

环境依赖

（Mac ，Window，Linux）系统下运行程序的相关环境

e.g.

For Mac

  • nodejs >= 8.0
  • yarn >= 1.7

运行

项目开发步骤

e.g.

  1. yarn
  2. yarn run start
  3. yarn run build

部署

部署到服务器的相关流程

fc9e3854caf799f81e9e75115153717cb8f32d2a