English | δΈζ
A Modularization Solution on Android platform.
- The processes that you navigate among Native Activity, H5, RN, Weex are complicated and don't have a consistent logic. (For example, some pages required login session while others not.)
- You want to display different UIs and functionalities to different user groups, but you have to add plenty of if/else blocks in all relevant areas.
- The module you are maintaining on is required to expose some APIs for other modules. However, no one wants to be dependent on each other directly and there is not a global universal communication channel that you can use (In that case, you may already got a lot of BroadcastReceivers or EventBuses everywhere)
- Although you work in a small team (probably less than ten people), team members still want to develop their modules as independently as possible, even build and debug one module independently without being influenced by others. (You may need to mock any other depended APIs)
- ...
All of these problems are what I have met and what Bro tries to solve. We suggest reading <From.Containerization.To.Modularity> before continue integrating Bro (shared by Oasis Feng at the end of 2016), you will get a clear target of what problems are modularization and componentization trying to solve.
(Quoted From the Slide)
Engineering
- Enforced decoupling for high-cohesion code.
- Module-independent(parallel) development and testing
- Flexible integration, deployment&upgrade
Product
- Selective Installation(light-weight initial install)
- Hybrid-friendly(web&native, mix&match)
- Open to (3rd-party) extensions
It's vital to emphasize this concept that Bro's goal is not to be a routing framework, but a lightweight modular infrastructure aimed at component decoupling and efficient development.
- Supports individual initialization for each module and be convenient to monitor the initialization cost;
- Supports Activity routing, and supports customizing global consistent URI rules for Native Activity and Web, ReactNative, Weex and other containers;
- Supports the interface exposure and interfaces acquisition among modules, and even to implement the acquisition Fragment or start Service from other modules.
- Supports customizing annotations (used by adding identification), sub-annotation-processor (used by generating custom routing table or docs), properties of Activities, Services, etc. (used by Interceptor).
- Supports global interceptors and monitors to intercept all the processes above-mentioned and acquires the custom properties of Activities and Services in interceptors conveniently.
- Supports automatically generating the page routing table (Java Class) and documentation including all custom properties.
- For more customization please refer to the best practices section of the subsequent documentation.
All docs are hosting on Github Page using Docsify. Contributing to /docs directory is welcome.
- How
- Why
- To be continued...
Bro is only supported & tested on latest 2 Minor versions of Android Gradle Plugin.
| AGP Version | Latest Support Version |
|---|---|
| 3.6.x | |
| 3.5.x | 1.3.4 |
| 3.4.x | 1.1.0 |
Check this link to make sure everyone will make a meaningful commit message.
So far we haven't added any hook tool, but follow the regex below:
(chore|feat|docs|fix|refactor|style|test|hack|release)(:)( )(.{0,80})
Copyright 2016-2020 2BAB
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent