Repository: alibaba/ARouter Branch: develop Commit: 60e6b63c6d30 Files: 148 Total size: 329.0 KB Directory structure: gitextract_0558mpl4/ ├── .github/ │ ├── ISSUE_TEMPLATE.md │ └── workflows/ │ └── gradle-wrapper-validation.yml ├── .gitignore ├── LICENSE ├── README.md ├── README_CN.md ├── app/ │ ├── build.gradle │ ├── doc/ │ │ └── debug/ │ │ └── debug.keystore │ ├── proguard-rules.pro │ └── src/ │ └── main/ │ ├── AndroidManifest.xml │ ├── assets/ │ │ └── scheme-test.html │ ├── java/ │ │ └── com/ │ │ └── alibaba/ │ │ └── android/ │ │ └── arouter/ │ │ └── demo/ │ │ ├── MainActivity.java │ │ └── SchemeFilterActivity.java │ └── res/ │ ├── anim/ │ │ ├── slide_in_bottom.xml │ │ └── slide_out_bottom.xml │ ├── drawable/ │ │ └── bg_test_area.xml │ ├── layout/ │ │ └── activity_main.xml │ └── values/ │ ├── color.xml │ ├── dimens.xml │ └── strings.xml ├── arouter-annotation/ │ ├── build.gradle │ ├── gradle.properties │ └── src/ │ └── main/ │ └── java/ │ └── com/ │ └── alibaba/ │ └── android/ │ └── arouter/ │ └── facade/ │ ├── annotation/ │ │ ├── Autowired.java │ │ ├── Interceptor.java │ │ ├── Param.java │ │ └── Route.java │ ├── enums/ │ │ ├── RouteType.java │ │ └── TypeKind.java │ └── model/ │ ├── RouteMeta.java │ └── TypeWrapper.java ├── arouter-api/ │ ├── build.gradle │ ├── gradle.properties │ └── src/ │ └── main/ │ ├── AndroidManifest.xml │ └── java/ │ └── com/ │ └── alibaba/ │ └── android/ │ └── arouter/ │ ├── base/ │ │ └── UniqueKeyTreeMap.java │ ├── core/ │ │ ├── AutowiredLifecycleCallback.java │ │ ├── AutowiredServiceImpl.java │ │ ├── InstrumentationHook.java │ │ ├── InterceptorServiceImpl.java │ │ ├── LogisticsCenter.java │ │ └── Warehouse.java │ ├── exception/ │ │ ├── HandlerException.java │ │ ├── InitException.java │ │ └── NoRouteFoundException.java │ ├── facade/ │ │ ├── Postcard.java │ │ ├── callback/ │ │ │ ├── InterceptorCallback.java │ │ │ ├── NavCallback.java │ │ │ └── NavigationCallback.java │ │ ├── service/ │ │ │ ├── AutowiredService.java │ │ │ ├── ClassLoaderService.java │ │ │ ├── DegradeService.java │ │ │ ├── InterceptorService.java │ │ │ ├── PathReplaceService.java │ │ │ ├── PretreatmentService.java │ │ │ └── SerializationService.java │ │ └── template/ │ │ ├── IInterceptor.java │ │ ├── IInterceptorGroup.java │ │ ├── ILogger.java │ │ ├── IPolicy.java │ │ ├── IProvider.java │ │ ├── IProviderGroup.java │ │ ├── IRouteGroup.java │ │ ├── IRouteRoot.java │ │ └── ISyringe.java │ ├── launcher/ │ │ ├── ARouter.java │ │ └── _ARouter.java │ ├── thread/ │ │ ├── CancelableCountDownLatch.java │ │ ├── DefaultPoolExecutor.java │ │ └── DefaultThreadFactory.java │ └── utils/ │ ├── ClassUtils.java │ ├── Consts.java │ ├── DefaultLogger.java │ ├── MapUtils.java │ ├── PackageUtils.java │ └── TextUtils.java ├── arouter-compiler/ │ ├── build.gradle │ ├── gradle.properties │ └── src/ │ └── main/ │ ├── java/ │ │ └── com/ │ │ └── alibaba/ │ │ └── android/ │ │ └── arouter/ │ │ └── compiler/ │ │ ├── entity/ │ │ │ └── RouteDoc.java │ │ ├── processor/ │ │ │ ├── AutowiredProcessor.java │ │ │ ├── BaseProcessor.java │ │ │ ├── InterceptorProcessor.java │ │ │ └── RouteProcessor.java │ │ └── utils/ │ │ ├── Consts.java │ │ ├── Logger.java │ │ └── TypeUtils.java │ └── resources/ │ └── META-INF/ │ └── gradle/ │ └── incremental.annotation.processors ├── arouter-gradle-plugin/ │ ├── build.gradle │ ├── gradle.properties │ └── src/ │ └── main/ │ ├── groovy/ │ │ └── com/ │ │ └── alibaba/ │ │ └── android/ │ │ └── arouter/ │ │ └── register/ │ │ ├── core/ │ │ │ ├── RegisterCodeGenerator.groovy │ │ │ └── RegisterTransform.groovy │ │ ├── launch/ │ │ │ └── PluginLaunch.groovy │ │ └── utils/ │ │ ├── Logger.groovy │ │ ├── ScanSetting.groovy │ │ └── ScanUtil.groovy │ └── resources/ │ └── META-INF/ │ └── gradle-plugins/ │ └── com.alibaba.arouter.properties ├── arouter-idea-plugin/ │ ├── build.gradle │ └── src/ │ └── main/ │ ├── kotlin/ │ │ └── com/ │ │ └── alibaba/ │ │ └── android/ │ │ └── arouter/ │ │ └── idea/ │ │ └── extensions/ │ │ └── NavigationLineMarker.kt │ └── resources/ │ └── META-INF/ │ └── plugin.xml ├── build.gradle ├── demo/ │ ├── arouter-demo-1.5.2.apk │ └── arouter-demo.apk ├── gradle/ │ ├── publish.gradle │ └── wrapper/ │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradle.properties ├── gradlew ├── gradlew.bat ├── module-java/ │ ├── build.gradle │ └── src/ │ └── main/ │ ├── AndroidManifest.xml │ ├── java/ │ │ └── com/ │ │ └── alibaba/ │ │ └── android/ │ │ └── arouter/ │ │ └── demo/ │ │ └── module1/ │ │ ├── BlankFragment.java │ │ ├── MainLooper.java │ │ ├── TestInterceptor90.java │ │ ├── TestModule2Activity.java │ │ ├── TestModuleActivity.java │ │ ├── TestWebview.java │ │ ├── testactivity/ │ │ │ ├── BaseActivity.java │ │ │ ├── Test1Activity.java │ │ │ ├── Test2Activity.java │ │ │ ├── Test3Activity.java │ │ │ ├── Test4Activity.java │ │ │ └── TestDynamicActivity.java │ │ ├── testinterceptor/ │ │ │ └── Test1Interceptor.java │ │ └── testservice/ │ │ ├── HelloServiceImpl.java │ │ ├── JsonServiceImpl.java │ │ └── SingleService.java │ └── res/ │ ├── layout/ │ │ ├── activity_test1.xml │ │ ├── activity_test2.xml │ │ ├── activity_test4.xml │ │ ├── activity_test_module.xml │ │ ├── activity_test_module2.xml │ │ └── activity_test_webview.xml │ └── values/ │ ├── dimens.xml │ └── strings.xml ├── module-java-export/ │ ├── build.gradle │ └── src/ │ └── main/ │ ├── AndroidManifest.xml │ └── java/ │ └── com/ │ └── alibaba/ │ └── android/ │ └── arouter/ │ └── demo/ │ └── service/ │ ├── Entrance.java │ ├── HelloService.java │ └── model/ │ ├── TestObj.java │ ├── TestParcelable.java │ └── TestSerializable.java ├── module-kotlin/ │ ├── build.gradle │ └── src/ │ └── main/ │ ├── AndroidManifest.xml │ ├── java/ │ │ └── com/ │ │ └── alibaba/ │ │ └── android/ │ │ └── arouter/ │ │ └── demo/ │ │ └── kotlin/ │ │ ├── KotlinTestActivity.kt │ │ └── TestNormalActivity.java │ └── res/ │ ├── layout/ │ │ ├── activity_kotlin_test.xml │ │ └── activity_test_normal.xml │ └── values/ │ ├── dimens.xml │ └── strings.xml └── settings.gradle ================================================ FILE CONTENTS ================================================ ================================================ FILE: .github/ISSUE_TEMPLATE.md ================================================ ## Look at here - → Did you read the doc carefully - → Did you add annotation above target activity - → Did you add annotation processor dependence - → **Receive only bugs and suggestions** ## 提 issue 前请看 - → 你是否已经熟读 [README](https://github.com/alibaba/ARouter/blob/master/README.md) ？ - → 你是否在每一个包含页面 or 服务的模块中依赖了 compiler sdk - → **这里不是答疑的地方，仅接受 bug 和建议，答疑请去答疑群** ================================================ FILE: .github/workflows/gradle-wrapper-validation.yml ================================================ name: "Validate Gradle Wrapper" on: [push, pull_request] jobs: validation: name: "Validation" runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - uses: gradle/wrapper-validation-action@v1 ================================================ FILE: .gitignore ================================================ # Built application files *.ap_ # Files for the Dalvik VM *.dex # Java class files *.class # Generated files bin/ gen/ # Gradle files .gradle/ build/ /*/build/ # Local configuration file (sdk path, etc) local.properties # Proguard folder generated by Eclipse proguard/ # Log Files *.log # IDEA Files .idea *.iml /*.ipr /*.iws .project .classpath # Eclipse Files /target *.classpath *.project *.settings app/src/main/res/values/config.xml app/src/main/res/drawable/yw_1222.jpg # OS X Files .DS_Store map.txt ================================================ FILE: LICENSE ================================================ Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} 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. ================================================ FILE: README.md ================================================ ``` A framework for assisting in the renovation of Android app componentization ``` [中文文档](https://github.com/alibaba/ARouter/blob/master/README_CN.md) ##### [![Join the chat at https://gitter.im/alibaba/ARouter](https://badges.gitter.im/alibaba/ARouter.svg)](https://gitter.im/alibaba/ARouter?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Hex.pm](https://img.shields.io/hexpm/l/plug.svg)](https://www.apache.org/licenses/LICENSE-2.0) --- #### Lastest version module|arouter-api|arouter-compiler|arouter-register|arouter-idea-plugin ---|---|---|---|--- version|[![Download](https://maven-badges.herokuapp.com/maven-central/com.alibaba/arouter-api/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.alibaba/arouter-api)|[![Download](https://maven-badges.herokuapp.com/maven-central/com.alibaba/arouter-compiler/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.alibaba/arouter-compiler)|[![Download](https://maven-badges.herokuapp.com/maven-central/com.alibaba/arouter-register/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.alibaba/arouter-register)|[![as plugin](https://img.shields.io/jetbrains/plugin/d/11428-arouter-helper.svg)](https://plugins.jetbrains.com/plugin/11428-arouter-helper) #### Demo ##### [Demo apk](https://github.com/alibaba/ARouter/blob/develop/demo/arouter-demo-1.5.2.apk)、[Demo Gif](https://raw.githubusercontent.com/alibaba/ARouter/master/demo/arouter-demo.gif) #### I. Feature 1. **Supports direct parsing of standard URLs for jumps and automatic injection of parameters into target pages** 2. **Support for multi-module** 3. **Support for interceptor** 4. **Support for dependency injection** 5. **InstantRun support** 6. **MultiDex support** 7. Mappings are grouped by group, multi-level management, on-demand initialization 8. Supports users to specify global demotion and local demotion strategies 9. Activity, interceptor and service can be automatically registered to the framework 10. Support multiple ways to configure transition animation 11. Support for fragment 12. Full kotlin support (Look at Other#2) 13. **Generate route doc support** 14. **Provide IDE plugin for quick navigation to target class** 15. Support Incremental annotation processing 16. Support register route meta dynamic. #### II. Classic Case 1. Forward from external URLs to internal pages, and parsing parameters 2. Jump and decoupling between multi-module 3. Intercept jump process, handle login, statistics and other logic 4. Cross-module communication, decouple components by IoC #### III. Configuration 1. Adding dependencies and configurations ``` gradle android { defaultConfig { ... javaCompileOptions { annotationProcessorOptions { arguments = [AROUTER_MODULE_NAME: project.getName()] } } } } dependencies { // Replace with the latest version compile 'com.alibaba:arouter-api:?' annotationProcessor 'com.alibaba:arouter-compiler:?' ... } // Old version of gradle plugin (< 2.2), You can use apt plugin, look at 'Other#1' // Kotlin configuration reference 'Other#2' ``` 2. Add annotations ``` java // Add annotations on pages that support routing (required) // The path here needs to pay attention to need at least two levels : /xx/xx @Route(path = "/test/activity") public class YourActivity extend Activity { ... } ``` 3. Initialize the SDK ``` java if (isDebug()) { // These two lines must be written before init, otherwise these configurations will be invalid in the init process ARouter.openLog(); // Print log ARouter.openDebug(); // Turn on debugging mode (If you are running in InstantRun mode, you must turn on debug mode! Online version needs to be closed, otherwise there is a security risk) } ARouter.init(mApplication); // As early as possible, it is recommended to initialize in the Application ``` 4. Initiate the routing ``` java // 1. Simple jump within application (Jump via URL in 'Advanced usage') ARouter.getInstance().build("/test/activity").navigation(); // 2. Jump with parameters ARouter.getInstance().build("/test/1") .withLong("key1", 666L) .withString("key3", "888") .withObject("key4", new Test("Jack", "Rose")) .navigation(); ``` 5. Add confusing rules (If Proguard is turn on) ``` -keep public class com.alibaba.android.arouter.routes.**{*;} -keep public class com.alibaba.android.arouter.facade.**{*;} -keep class * implements com.alibaba.android.arouter.facade.template.ISyringe{*;} # If you use the byType method to obtain Service, add the following rules to protect the interface: -keep interface * implements com.alibaba.android.arouter.facade.template.IProvider # If single-type injection is used, that is, no interface is defined to implement IProvider, the following rules need to be added to protect the implementation # -keep class * implements com.alibaba.android.arouter.facade.template.IProvider ``` 6. Using the custom gradle plugin to autoload the routing table ```gradle apply plugin: 'com.alibaba.arouter' buildscript { repositories { mavenCentral() } dependencies { // Replace with the latest version classpath "com.alibaba:arouter-register:?" } } ``` Optional, use the registration plugin provided by the ARouter to automatically load the routing table(power by [AutoRegister](https://github.com/luckybilly/AutoRegister)). By default, the ARouter will scanned the dex files . Performing an auto-registration via the gradle plugin can shorten the initialization time , it should be noted that the plugin must be used with api above 1.3.0! 7. use ide plugin for quick navigation to target class (Optional) Search for `ARouter Helper` in the Android Studio plugin market, or directly download the `arouter-idea-plugin` zip installation package listed in the `Latest version` above the documentation, after installation plugin without any settings, U can find an icon at the beginning of the jump code. (![navigation](https://raw.githubusercontent.com/alibaba/ARouter/develop/arouter-idea-plugin/src/main/resources/icon/outline_my_location_black_18dp.png)) click the icon to jump to the target class that identifies the path in the code. #### IV. Advanced usage 1. Jump via URL ``` java // Create a new Activity for monitoring Scheme events, and then directly pass url to ARouter public class SchemeFilterActivity extends Activity { @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); Uri uri = getIntent().getData(); ARouter.getInstance().build(uri).navigation(); finish(); } } ``` AndroidManifest.xml ``` xml ``` 2. Parse the parameters in the URL ``` java // Declare a field for each parameter and annotate it with @Autowired @Route(path = "/test/activity") public class Test1Activity extends Activity { @Autowired public String name; @Autowired int age; @Autowired(name = "girl") // Map different parameters in the URL by name boolean boy; @Autowired TestObj obj; // Support for parsing custom objects, using json pass in URL @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); ARouter.getInstance().inject(this); // ARouter will automatically set value of fields Log.d("param", name + age + boy); } } // If you need to pass a custom object, Create a new class(Not the custom object class),implement the SerializationService, And use the @Route annotation annotation, E.g: @Route(path = "/yourservicegroupname/json") public class JsonServiceImpl implements SerializationService { @Override public void init(Context context) { } @Override public T json2Object(String text, Class clazz) { return JSON.parseObject(text, clazz); } @Override public String object2Json(Object instance) { return JSON.toJSONString(instance); } } ``` 3. Declaration Interceptor (Intercept jump process, AOP) ``` java // A more classic application is to handle login events during a jump so that there is no need to repeat the login check on the target page. // Interceptors will be executed between jumps, multiple interceptors will be executed in order of priority @Interceptor(priority = 8, name = "test interceptor") public class TestInterceptor implements IInterceptor { @Override public void process(Postcard postcard, InterceptorCallback callback) { ... // No problem! hand over control to the framework callback.onContinue(postcard); // Interrupt routing process // callback.onInterrupt(new RuntimeException("Something exception")); // The above two types need to call at least one of them, otherwise it will not continue routing } @Override public void init(Context context) { // Interceptor initialization, this method will be called when sdk is initialized, it will only be called once } } ``` 4. Processing jump results ``` java // U can get the result of a single jump ARouter.getInstance().build("/test/1").navigation(this, new NavigationCallback() { @Override public void onFound(Postcard postcard) { ... } @Override public void onLost(Postcard postcard) { ... } }); ``` 5. Custom global demotion strategy ``` java // Implement the DegradeService interface @Route(path = "/xxx/xxx") public class DegradeServiceImpl implements DegradeService { @Override public void onLost(Context context, Postcard postcard) { // do something. } @Override public void init(Context context) { } } ``` 6. Decoupled by dependency injection : Service management -- Exposure services ``` java // Declaration interface, other components get the service instance through the interface public interface HelloService extends IProvider { String sayHello(String name); } @Route(path = "/yourservicegroupname/hello", name = "test service") public class HelloServiceImpl implements HelloService { @Override public String sayHello(String name) { return "hello, " + name; } @Override public void init(Context context) { } } ``` 7. Decoupled by dependency injection : Service management -- Discovery service ``` java public class Test { @Autowired HelloService helloService; @Autowired(name = "/yourservicegroupname/hello") HelloService helloService2; HelloService helloService3; HelloService helloService4; public Test() { ARouter.getInstance().inject(this); } public void testService() { // 1. Use Dependency Injection to discover services, annotate fields with annotations helloService.sayHello("Vergil"); helloService2.sayHello("Vergil"); // 2. Discovering services using dependency lookup, the following two methods are byName and byType helloService3 = ARouter.getInstance().navigation(HelloService.class); helloService4 = (HelloService) ARouter.getInstance().build("/yourservicegroupname/hello").navigation(); helloService3.sayHello("Vergil"); helloService4.sayHello("Vergil"); } } ``` 8. Pretreatment Service ``` java @Route(path = "/xxx/xxx") public class PretreatmentServiceImpl implements PretreatmentService { @Override public boolean onPretreatment(Context context, Postcard postcard) { // Do something before the navigation, if you need to handle the navigation yourself, the method returns false } @Override public void init(Context context) { } } ``` 9. Dynamic register route meta Applicable to apps with plug-in architectures or some scenarios where routing information needs to be dynamically registered，Dynamic registration can be achieved through the interface provided by ARouter, The target page and service need not be marked with @Route annotation，**Only the routing information of the same group can be registered in the same batch** ``` java ARouter.getInstance().addRouteGroup(new IRouteGroup() { @Override public void loadInto(Map atlas) { atlas.put("/dynamic/activity", // path RouteMeta.build( RouteType.ACTIVITY, // Route type TestDynamicActivity.class, // Target class "/dynamic/activity", // Path "dynamic", // Group 0, // not need 0 // Extra tag, Used to mark page feature ) ); } }); ``` #### V. More features 1. Other settings in initialization ``` java ARouter.openLog(); // Open log ARouter.openDebug(); // When using InstantRun, you need to open this switch and turn it off after going online. Otherwise, there is a security risk. ARouter.printStackTrace(); // Print thread stack when printing logs ``` 2. API description ``` java // Build a standard route request ARouter.getInstance().build("/home/main").navigation(); // Build a standard route request, via URI Uri uri; ARouter.getInstance().build(uri).navigation(); // Build a standard route request, startActivityForResult // The first parameter must be Activity and the second parameter is RequestCode ARouter.getInstance().build("/home/main", "ap").navigation(this, 5); // Pass Bundle directly Bundle params = new Bundle(); ARouter.getInstance() .build("/home/main") .with(params) .navigation(); // Set Flag ARouter.getInstance() .build("/home/main") .withFlags(); .navigation(); // For fragment Fragment fragment = (Fragment) ARouter.getInstance().build("/test/fragment").navigation(); // transfer the object ARouter.getInstance() .withObject("key", new TestObj("Jack", "Rose")) .navigation(); // Think the interface is not enough, you can directly set parameter into Bundle ARouter.getInstance() .build("/home/main") .getExtra(); // Transition animation (regular mode) ARouter.getInstance() .build("/test/activity2") .withTransition(R.anim.slide_in_bottom, R.anim.slide_out_bottom) .navigation(this); // Transition animation (API16+) ActivityOptionsCompat compat = ActivityOptionsCompat. makeScaleUpAnimation(v, v.getWidth() / 2, v.getHeight() / 2, 0, 0); // ps. makeSceneTransitionAnimation, When using shared elements, you need to pass in the current Activity in the navigation method ARouter.getInstance() .build("/test/activity2") .withOptionsCompat(compat) .navigation(); // Use green channel (skip all interceptors) ARouter.getInstance().build("/home/main").greenChannel().navigation(); // Use your own log tool to print logs ARouter.setLogger(); // Use your custom thread pool ARouter.setExecutor(); ``` 3. Get the original URI ``` java String uriStr = getIntent().getStringExtra(ARouter.RAW_URI); ``` 4. Rewrite URL ``` java // Implement the PathReplaceService interface @Route(path = "/xxx/xxx") public class PathReplaceServiceImpl implements PathReplaceService { /** * For normal path. * * @param path raw path */ String forString(String path) { // Custom logic return path; } /** * For uri type. * * @param uri raw uri */ Uri forUri(Uri uri) { // Custom logic return url; } } ``` 5. Generate router doc ``` gradle // Edit build.gradle, add option 'AROUTER_GENERATE_DOC = enable' // Doc file : build/generated/source/apt/(debug or release)/com/alibaba/android/arouter/docs/arouter-map-of-${moduleName}.json android { defaultConfig { ... javaCompileOptions { annotationProcessorOptions { arguments = [AROUTER_MODULE_NAME: project.getName(), AROUTER_GENERATE_DOC: "enable"] } } } } ``` #### VI. Other 1. Old version of gradle plugin configuration ``` gradle apply plugin: 'com.neenbedankt.android-apt' buildscript { repositories { mavenCentral() } dependencies { classpath 'com.neenbedankt.gradle.plugins:android-apt:1.4' } } apt { arguments { AROUTER_MODULE_NAME project.getName(); } } dependencies { compile 'com.alibaba:arouter-api:x.x.x' apt 'com.alibaba:arouter-compiler:x.x.x' ... } ``` 2. Kotlin project configuration ``` // You can refer to the wording in the "module-kotlin" module apply plugin: 'kotlin-kapt' kapt { arguments { arg("AROUTER_MODULE_NAME", project.getName()) } } dependencies { compile 'com.alibaba:arouter-api:x.x.x' kapt 'com.alibaba:arouter-compiler:x.x.x' ... } ``` #### VII. Communication 1. Communication 1. DingDing group1 ![dingding](https://raw.githubusercontent.com/alibaba/ARouter/master/demo/dingding-group-1.png) 2. QQ group1 ![qq](https://raw.githubusercontent.com/alibaba/ARouter/master/demo/qq-group-1.png) 3. QQ group2 ![qq](https://raw.githubusercontent.com/alibaba/ARouter/master/demo/qq-group-2.png) ================================================ FILE: README_CN.md ================================================ ``` 一个用于帮助 Android App 进行组件化改造的框架 —— 支持模块间的路由、通信、解耦 ``` [English](https://github.com/alibaba/ARouter/blob/master/README.md) ##### [![Join the chat at https://gitter.im/alibaba/ARouter](https://badges.gitter.im/alibaba/ARouter.svg)](https://gitter.im/alibaba/ARouter?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Hex.pm](https://img.shields.io/hexpm/l/plug.svg)](https://www.apache.org/licenses/LICENSE-2.0) --- #### 最新版本 模块|arouter-api|arouter-compiler|arouter-register|arouter-idea-plugin ---|---|---|---|--- 最新版本|[![Download](https://maven-badges.herokuapp.com/maven-central/com.alibaba/arouter-api/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.alibaba/arouter-api)|[![Download](https://maven-badges.herokuapp.com/maven-central/com.alibaba/arouter-compiler/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.alibaba/arouter-compiler)|[![Download](https://maven-badges.herokuapp.com/maven-central/com.alibaba/arouter-register/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.alibaba/arouter-register)|[![as plugin](https://img.shields.io/jetbrains/plugin/d/11428-arouter-helper.svg)](https://plugins.jetbrains.com/plugin/11428-arouter-helper) #### Demo展示 ##### [Demo apk下载](https://github.com/alibaba/ARouter/blob/develop/demo/arouter-demo-1.5.2.apk)、[Demo Gif](https://raw.githubusercontent.com/alibaba/ARouter/master/demo/arouter-demo.gif) #### 一、功能介绍 1. **支持直接解析标准URL进行跳转，并自动注入参数到目标页面中** 2. **支持多模块工程使用** 3. **支持添加多个拦截器，自定义拦截顺序** 4. **支持依赖注入，可单独作为依赖注入框架使用** 5. **支持InstantRun** 6. **支持MultiDex**(Google方案) 7. 映射关系按组分类、多级管理，按需初始化 8. 支持用户指定全局降级与局部降级策略 9. 页面、拦截器、服务等组件均自动注册到框架 10. 支持多种方式配置转场动画 11. 支持获取Fragment 12. 完全支持Kotlin以及混编(配置见文末 其他#5) 13. **支持第三方 App 加固**(使用 arouter-register 实现自动注册) 14. **支持生成路由文档** 15. **提供 IDE 插件便捷的关联路径和目标类** 16. 支持增量编译(开启文档生成后无法增量编译) 17. 支持动态注册路由信息 #### 二、典型应用 1. 从外部URL映射到内部页面，以及参数传递与解析 2. 跨模块页面跳转，模块间解耦 3. 拦截跳转过程，处理登陆、埋点等逻辑 4. 跨模块API调用，通过控制反转来做组件解耦 #### 三、基础功能 1. 添加依赖和配置 ``` gradle android { defaultConfig { ... javaCompileOptions { annotationProcessorOptions { arguments = [AROUTER_MODULE_NAME: project.getName()] } } } } dependencies { // 替换成最新版本, 需要注意的是api // 要与compiler匹配使用，均使用最新版可以保证兼容 compile 'com.alibaba:arouter-api:x.x.x' annotationProcessor 'com.alibaba:arouter-compiler:x.x.x' ... } // 旧版本gradle插件(< 2.2)，可以使用apt插件，配置方法见文末'其他#4' // Kotlin配置参考文末'其他#5' ``` 2. 添加注解 ``` java // 在支持路由的页面上添加注解(必选) // 这里的路径需要注意的是至少需要有两级，/xx/xx @Route(path = "/test/activity") public class YourActivity extend Activity { ... } ``` 3. 初始化SDK ``` java if (isDebug()) { // 这两行必须写在init之前，否则这些配置在init过程中将无效 ARouter.openLog(); // 打印日志 ARouter.openDebug(); // 开启调试模式(如果在InstantRun模式下运行，必须开启调试模式！线上版本需要关闭,否则有安全风险) } ARouter.init(mApplication); // 尽可能早，推荐在Application中初始化 ``` 4. 发起路由操作 ``` java // 1. 应用内简单的跳转(通过URL跳转在'进阶用法'中) ARouter.getInstance().build("/test/activity").navigation(); // 2. 跳转并携带参数 ARouter.getInstance().build("/test/1") .withLong("key1", 666L) .withString("key3", "888") .withObject("key4", new Test("Jack", "Rose")) .navigation(); ``` 5. 添加混淆规则(如果使用了Proguard) ``` -keep public class com.alibaba.android.arouter.routes.**{*;} -keep public class com.alibaba.android.arouter.facade.**{*;} -keep class * implements com.alibaba.android.arouter.facade.template.ISyringe{*;} # 如果使用了 byType 的方式获取 Service，需添加下面规则，保护接口 -keep interface * implements com.alibaba.android.arouter.facade.template.IProvider # 如果使用了 单类注入，即不定义接口实现 IProvider，需添加下面规则，保护实现 # -keep class * implements com.alibaba.android.arouter.facade.template.IProvider ``` 6. 使用 Gradle 插件实现路由表的自动加载 (可选) ```gradle apply plugin: 'com.alibaba.arouter' buildscript { repositories { mavenCentral() } dependencies { classpath "com.alibaba:arouter-register:?" } } ``` 可选使用，通过 ARouter 提供的注册插件进行路由表的自动加载(power by [AutoRegister](https://github.com/luckybilly/AutoRegister))， 默认通过扫描 dex 的方式 进行加载通过 gradle 插件进行自动注册可以缩短初始化时间解决应用加固导致无法直接访问 dex 文件，初始化失败的问题，需要注意的是，该插件必须搭配 api 1.3.0 以上版本使用！ 7. 使用 IDE 插件导航到目标类 (可选) 在 Android Studio 插件市场中搜索 `ARouter Helper`, 或者直接下载文档上方 `最新版本` 中列出的 `arouter-idea-plugin` zip 安装包手动安装，安装后 插件无任何设置，可以在跳转代码的行首找到一个图标 (![navigation](https://raw.githubusercontent.com/alibaba/ARouter/develop/arouter-idea-plugin/src/main/resources/icon/outline_my_location_black_18dp.png)) 点击该图标，即可跳转到标识了代码中路径的目标类 #### 四、进阶用法 1. 通过URL跳转 ``` java // 新建一个Activity用于监听Scheme事件,之后直接把url传递给ARouter即可 public class SchemeFilterActivity extends Activity { @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); Uri uri = getIntent().getData(); ARouter.getInstance().build(uri).navigation(); finish(); } } ``` AndroidManifest.xml ``` xml ``` 2. 解析参数 ``` java // 为每一个参数声明一个字段，并使用 @Autowired 标注 // URL中不能传递Parcelable类型数据，通过ARouter api可以传递Parcelable对象 @Route(path = "/test/activity") public class Test1Activity extends Activity { @Autowired public String name; @Autowired int age; // 通过name来映射URL中的不同参数 @Autowired(name = "girl") boolean boy; // 支持解析自定义对象，URL中使用json传递 @Autowired TestObj obj; // 使用 withObject 传递 List 和 Map 的实现了 // Serializable 接口的实现类(ArrayList/HashMap) // 的时候，接收该对象的地方不能标注具体的实现类类型 // 应仅标注为 List 或 Map，否则会影响序列化中类型 // 的判断, 其他类似情况需要同样处理 @Autowired List list; @Autowired Map> map; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); ARouter.getInstance().inject(this); // ARouter会自动对字段进行赋值，无需主动获取 Log.d("param", name + age + boy); } } // 如果需要传递自定义对象，新建一个类（并非自定义对象类），然后实现 SerializationService,并使用@Route注解标注(方便用户自行选择序列化方式)，例如： @Route(path = "/yourservicegroupname/json") public class JsonServiceImpl implements SerializationService { @Override public void init(Context context) { } @Override public T json2Object(String text, Class clazz) { return JSON.parseObject(text, clazz); } @Override public String object2Json(Object instance) { return JSON.toJSONString(instance); } } ``` 3. 声明拦截器(拦截跳转过程，面向切面编程) ``` java // 比较经典的应用就是在跳转过程中处理登陆事件，这样就不需要在目标页重复做登陆检查 // 拦截器会在跳转之间执行，多个拦截器会按优先级顺序依次执行 @Interceptor(priority = 8, name = "测试用拦截器") public class TestInterceptor implements IInterceptor { @Override public void process(Postcard postcard, InterceptorCallback callback) { ... callback.onContinue(postcard); // 处理完成，交还控制权 // callback.onInterrupt(new RuntimeException("我觉得有点异常")); // 觉得有问题，中断路由流程 // 以上两种至少需要调用其中一种，否则不会继续路由 } @Override public void init(Context context) { // 拦截器的初始化，会在sdk初始化的时候调用该方法，仅会调用一次 } } ``` 4. 处理跳转结果 ``` java // 使用两个参数的navigation方法，可以获取单次跳转的结果 ARouter.getInstance().build("/test/1").navigation(this, new NavigationCallback() { @Override public void onFound(Postcard postcard) { ... } @Override public void onLost(Postcard postcard) { ... } }); ``` 5. 自定义全局降级策略 ``` java // 实现DegradeService接口，并加上一个Path内容任意的注解即可 @Route(path = "/xxx/xxx") public class DegradeServiceImpl implements DegradeService { @Override public void onLost(Context context, Postcard postcard) { // do something. } @Override public void init(Context context) { } } ``` 6. 为目标页面声明更多信息 ``` java // 我们经常需要在目标页面中配置一些属性，比方说"是否需要登陆"之类的 // 可以通过 Route 注解中的 extras 属性进行扩展，这个属性是一个 int值，换句话说，单个int有4字节，也就是32位，可以配置32个开关 // 剩下的可以自行发挥，通过字节操作可以标识32个开关，通过开关标记目标页面的一些属性，在拦截器中可以拿到这个标记进行业务逻辑判断 @Route(path = "/test/activity", extras = Consts.XXXX) ``` 7. 通过依赖注入解耦:服务管理(一) 暴露服务 ``` java // 声明接口,其他组件通过接口来调用服务 public interface HelloService extends IProvider { String sayHello(String name); } // 实现接口 @Route(path = "/yourservicegroupname/hello", name = "测试服务") public class HelloServiceImpl implements HelloService { @Override public String sayHello(String name) { return "hello, " + name; } @Override public void init(Context context) { } } ``` 8. 通过依赖注入解耦:服务管理(二) 发现服务 ``` java public class Test { @Autowired HelloService helloService; @Autowired(name = "/yourservicegroupname/hello") HelloService helloService2; HelloService helloService3; HelloService helloService4; public Test() { ARouter.getInstance().inject(this); } public void testService() { // 1. (推荐)使用依赖注入的方式发现服务,通过注解标注字段,即可使用，无需主动获取 // Autowired注解中标注name之后，将会使用byName的方式注入对应的字段，不设置name属性，会默认使用byType的方式发现服务(当同一接口有多个实现的时候，必须使用byName的方式发现服务) helloService.sayHello("Vergil"); helloService2.sayHello("Vergil"); // 2. 使用依赖查找的方式发现服务，主动去发现服务并使用，下面两种方式分别是byName和byType helloService3 = ARouter.getInstance().navigation(HelloService.class); helloService4 = (HelloService) ARouter.getInstance().build("/yourservicegroupname/hello").navigation(); helloService3.sayHello("Vergil"); helloService4.sayHello("Vergil"); } } ``` 9. 预处理服务 ``` java // 实现 PretreatmentService 接口，并加上一个Path内容任意的注解即可 @Route(path = "/xxx/xxx") public class PretreatmentServiceImpl implements PretreatmentService { @Override public boolean onPretreatment(Context context, Postcard postcard) { // 跳转前预处理，如果需要自行处理跳转，该方法返回 false 即可 } @Override public void init(Context context) { } } ``` 10. 动态注册路由信息 适用于部分插件化架构的App以及需要动态注册路由信息的场景，可以通过 ARouter 提供的接口实现动态注册 路由信息，目标页面和服务可以不标注 @Route 注解，**注意：同一批次仅允许相同 group 的路由信息注册** ``` java ARouter.getInstance().addRouteGroup(new IRouteGroup() { @Override public void loadInto(Map atlas) { atlas.put("/dynamic/activity", // path RouteMeta.build( RouteType.ACTIVITY, // 路由信息 TestDynamicActivity.class, // 目标的 Class "/dynamic/activity", // Path "dynamic", // Group, 尽量保持和 path 的第一段相同 0, // 优先级，暂未使用 0 // Extra，用于给页面打标 ) ); } }); ``` #### 五、更多功能 1. 初始化中的其他设置 ``` java ARouter.openLog(); // 开启日志 ARouter.openDebug(); // 使用InstantRun的时候，需要打开该开关，上线之后关闭，否则有安全风险 ARouter.printStackTrace(); // 打印日志的时候打印线程堆栈 ``` 2. 详细的API说明 ``` java // 构建标准的路由请求 ARouter.getInstance().build("/home/main").navigation(); // 构建标准的路由请求，并指定分组 ARouter.getInstance().build("/home/main", "ap").navigation(); // 构建标准的路由请求，通过Uri直接解析 Uri uri; ARouter.getInstance().build(uri).navigation(); // 构建标准的路由请求，startActivityForResult // navigation的第一个参数必须是Activity，第二个参数则是RequestCode ARouter.getInstance().build("/home/main", "ap").navigation(this, 5); // 直接传递Bundle Bundle params = new Bundle(); ARouter.getInstance() .build("/home/main") .with(params) .navigation(); // 指定Flag ARouter.getInstance() .build("/home/main") .withFlags(); .navigation(); // 获取Fragment Fragment fragment = (Fragment) ARouter.getInstance().build("/test/fragment").navigation(); // 对象传递 ARouter.getInstance() .withObject("key", new TestObj("Jack", "Rose")) .navigation(); // 觉得接口不够多，可以直接拿出Bundle赋值 ARouter.getInstance() .build("/home/main") .getExtra(); // 转场动画(常规方式) ARouter.getInstance() .build("/test/activity2") .withTransition(R.anim.slide_in_bottom, R.anim.slide_out_bottom) .navigation(this); // 转场动画(API16+) ActivityOptionsCompat compat = ActivityOptionsCompat. makeScaleUpAnimation(v, v.getWidth() / 2, v.getHeight() / 2, 0, 0); // ps. makeSceneTransitionAnimation 使用共享元素的时候，需要在navigation方法中传入当前Activity ARouter.getInstance() .build("/test/activity2") .withOptionsCompat(compat) .navigation(); // 使用绿色通道(跳过所有的拦截器) ARouter.getInstance().build("/home/main").greenChannel().navigation(); // 使用自己的日志工具打印日志 ARouter.setLogger(); // 使用自己提供的线程池 ARouter.setExecutor(); ``` 3. 获取原始的URI ``` java String uriStr = getIntent().getStringExtra(ARouter.RAW_URI); ``` 4. 重写跳转URL ``` java // 实现PathReplaceService接口，并加上一个Path内容任意的注解即可 @Route(path = "/xxx/xxx") // 必须标明注解 public class PathReplaceServiceImpl implements PathReplaceService { /** * For normal path. * * @param path raw path */ String forString(String path) { return path; // 按照一定的规则处理之后返回处理后的结果 } /** * For uri type. * * @param uri raw uri */ Uri forUri(Uri uri) { return url; // 按照一定的规则处理之后返回处理后的结果 } } ``` 5. 生成路由文档 ``` gradle // 更新 build.gradle, 添加参数 AROUTER_GENERATE_DOC = enable // 生成的文档路径 : build/generated/source/apt/(debug or release)/com/alibaba/android/arouter/docs/arouter-map-of-${moduleName}.json android { defaultConfig { ... javaCompileOptions { annotationProcessorOptions { arguments = [AROUTER_MODULE_NAME: project.getName(), AROUTER_GENERATE_DOC: "enable"] } } } } ``` #### 六、其他 1. 路由中的分组概念 - SDK中针对所有的路径(/test/1 /test/2)进行分组，分组只有在分组中的某一个路径第一次被访问的时候，该分组才会被初始化 - 可以通过 @Route 注解主动指定分组，否则使用路径中第一段字符串(/*/)作为分组 - 注意：一旦主动指定分组之后，应用内路由需要使用 ARouter.getInstance().build(path, group) 进行跳转，手动指定分组，否则无法找到 ``` java @Route(path = "/test/1", group = "app") ``` 2. 拦截器和服务的异同 - 拦截器和服务所需要实现的接口不同，但是结构类似，都存在 init(Context context) 方法，但是两者的调用时机不同 - 拦截器因为其特殊性，会被任何一次路由所触发，拦截器会在ARouter初始化的时候异步初始化，如果第一次路由的时候拦截器还没有初始化结束，路由会等待，直到初始化完成。 - 服务没有该限制，某一服务可能在App整个生命周期中都不会用到，所以服务只有被调用的时候才会触发初始化操作 3. 旧版本gradle插件的配置方式 ``` gradle apply plugin: 'com.neenbedankt.android-apt' buildscript { repositories { mavenCentral() } dependencies { classpath 'com.neenbedankt.gradle.plugins:android-apt:1.4' } } apt { arguments { AROUTER_MODULE_NAME project.getName(); } } dependencies { compile 'com.alibaba:arouter-api:x.x.x' apt 'com.alibaba:arouter-compiler:x.x.x' ... } ``` 4. Kotlin项目中的配置方式 ``` // 可以参考 module-kotlin 模块中的写法 apply plugin: 'kotlin-kapt' kapt { arguments { arg("AROUTER_MODULE_NAME", project.getName()) } } dependencies { compile 'com.alibaba:arouter-api:x.x.x' kapt 'com.alibaba:arouter-compiler:x.x.x' ... } ``` #### 七、Q&A 1. "W/ARouter::: ARouter::No postcard![ ]" 这个Log正常的情况下也会打印出来，如果您的代码中没有实现DegradeService和PathReplaceService的话，因为ARouter本身的一些功能也依赖 自己提供的Service管理功能，ARouter在跳转的时候会尝试寻找用户实现的PathReplaceService，用于对路径进行重写(可选功能)，所以如果您没有 实现这个服务的话，也会抛出这个日志 推荐在app中实现DegradeService、PathReplaceService 2. "W/ARouter::: ARouter::There is no route match the path [/xxx/xxx], in group [xxx][ ]" - 通常来说这种情况是没有找到目标页面，目标不存在 - 如果这个页面是存在的，那么您可以按照下面的步骤进行排查 1. 检查目标页面的注解是否配置正确，正确的注解形式应该是 (@Route(path="/test/test"), 如没有特殊需求，请勿指定group字段，废弃功能) 2. 检查目标页面所在的模块的gradle脚本中是否依赖了 arouter-compiler sdk (需要注意的是，要使用apt依赖，而不是compile关键字依赖) 3. 检查编译打包日志，是否出现了形如 ARouter::Compiler >>> xxxxx 的日志，日志中会打印出发现的路由目标 4. 启动App的时候，开启debug、log(openDebug/openLog), 查看映射表是否已经被扫描出来，形如 D/ARouter::: LogisticsCenter has already been loaded, GroupIndex[4]，GroupIndex > 0 3. 开启InstantRun之后无法跳转(高版本Gradle插件下无法跳转)？ 因为开启InstantRun之后，很多类文件不会放在原本的dex中，需要单独去加载，ARouter默认不会去加载这些文件，因为安全原因，只有在开启了openDebug之后 ARouter才回去加载InstantRun产生的文件，所以在以上的情况下，需要在init**之前**调用openDebug 4. TransformException:java.util.zip.ZipException: duplicate entry .... ARouter有按组加载的机制，关于分组可以参考 6-1 部分，ARouter允许一个module中存在多个分组，但是不允许多个module中存在相同的分组，会导致映射文件冲突 5. Kotlin类中的字段无法注入如何解决？ 首先，Kotlin中的字段是可以自动注入的，但是注入代码为了减少反射，使用的字段赋值的方式来注入的，Kotlin默认会生成set/get方法，并把属性设置为private 所以只要保证Kotlin中字段可见性不是private即可，简单解决可以在字段上添加 @JvmField 6. 通过URL跳转之后，在intent中拿不到参数如何解决？ 需要注意的是，如果不使用自动注入，那么可以不写 `ARouter.getInstance().inject(this)`，但是需要取值的字段仍然需要标上 `@Autowired` 注解，因为 只有标上注解之后，ARouter才能知道以哪一种数据类型提取URL中的参数并放入Intent中，这样您才能在intent中获取到对应的参数 7. 新增页面之后，无法跳转？ ARouter加载Dex中的映射文件会有一定耗时，所以ARouter会缓存映射文件，直到新版本升级(版本号或者versionCode变化)，而如果是开发版本(ARouter.openDebug())， ARouter 每次启动都会重新加载映射文件，开发阶段一定要打开 Debug 功能 #### 八、其他 1. 沟通和交流 1. 钉钉交流群1 ![qq](https://raw.githubusercontent.com/alibaba/ARouter/master/demo/dingding-group-1.png) 2. QQ 交流群1 ![qq](https://raw.githubusercontent.com/alibaba/ARouter/master/demo/qq-group-1.png) 3. QQ 交流群2 ![qq](https://raw.githubusercontent.com/alibaba/ARouter/master/demo/qq-group-2.png) ================================================ FILE: app/build.gradle ================================================ apply plugin: 'com.android.application' apply plugin: 'com.alibaba.arouter' android { compileSdkVersion Integer.parseInt(COMPILE_SDK_VERSION) buildToolsVersion BUILDTOOLS_VERSION defaultConfig { minSdkVersion Integer.parseInt(MIN_SDK_VERSION) targetSdkVersion Integer.parseInt(TARGET_SDK_VERSION) versionName "0.0.1" } compileOptions { sourceCompatibility JavaVersion.VERSION_1_7 targetCompatibility JavaVersion.VERSION_1_7 } signingConfigs { debug { storeFile file("./doc/debug/debug.keystore") storePassword "android" keyAlias "androiddebugkey" keyPassword "android" } } buildTypes { debug { minifyEnabled false signingConfig signingConfigs.debug } release { minifyEnabled true signingConfig signingConfigs.debug proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' } } lintOptions { abortOnError false } } dependencies { implementation project(':arouter-api') // 开发中依赖对方的 service 包 implementation project(':module-java-export') implementation project(':module-java') implementation project(':module-kotlin') implementation "com.android.support:support-v4:${SUPPORT_LIB_VERSION}" implementation "com.android.support:appcompat-v7:${SUPPORT_LIB_VERSION}" } ================================================ FILE: app/proguard-rules.pro ================================================ -optimizationpasses 5 -dontpreverify -dontwarn -ignorewarnings -verbose -overloadaggressively -dontusemixedcaseclassnames -dontskipnonpubliclibraryclasses -dontskipnonpubliclibraryclassmembers -keepattributes EnclosingMethod, *Annotation*, *JavascriptInterface*, InnerClasses, Signature -optimizations !code/simplification/arithmetic,!field/*,!class/merging/* # Android Framework -keep public class * extends android.app.Activity -keep public class * extends android.app.Application -keep public class * extends android.app.Service -keep public class * extends android.content.BroadcastReceiver -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 -keepclasseswithmembers class * { public (android.content.Context,android.util.AttributeSet); } -keepclasseswithmembers class * { public (android.content.Context,android.util.AttributeSet,int); } -keepclassmembers class * implements java.io.Serializable { static final long serialVersionUID; private static final java.io.ObjectStreamField[] serialPersistentFields; !static !transient ; private void writeObject(java.io.ObjectOutputStream); private void readObject(java.io.ObjectInputStream); java.lang.Object writeReplace(); java.lang.Object readResolve(); } -keep class * extends android.os.Parcelable { public static final android.os.Parcelable$Creator *; } -keepclasseswithmembernames class * { native ; } -keepclasseswithmembers,allowshrinking class * { native ; } -keepclassmembers enum * { public static **[] values(); public static ** valueOf(java.lang.String); } -keepclassmembers class **.R$* { public static ; } -keepclassmembers class * extends android.content.Context { public void *(android.view.View); public void *(android.view.MenuItem); } -keepclassmembers class * extends android.app.Activity { public void *(android.view.View); } -dontwarn com.alibaba.fastjson.** -keep class com.alibaba.fastjson.**{*;} # ARouter -keep public class com.alibaba.android.arouter.routes.**{*;} -keep class * implements com.alibaba.android.arouter.facade.template.ISyringe{*;} -keep interface * implements com.alibaba.android.arouter.facade.template.IProvider ================================================ FILE: app/src/main/AndroidManifest.xml ================================================ ================================================ FILE: app/src/main/assets/scheme-test.html ================================================

跳转测试

自定义Scheme[通常来说都是这样的]

arouter://m.aliyun.com/test/activity1

测试URL Encode情况

arouter://m.aliyun.com/test/activity1?name=alex&age=18&boy=true&high=180&obj={"name":"jack","id":"666"}

arouter://m.aliyun.com/test/activity2

arouter://m.aliyun.com/test/activity2?key1=value1

arouter://m.aliyun.com/test/activity3?name=alex&age=18&boy=true&high=180

App Links[防止被App屏蔽]

http://m.aliyun.com/test/activity1

http://m.aliyun.com/test/activity2

================================================ FILE: app/src/main/java/com/alibaba/android/arouter/demo/MainActivity.java ================================================ package com.alibaba.android.arouter.demo; import android.content.Intent; import android.net.Uri; import android.os.Build; import android.os.Bundle; import android.support.v4.app.ActivityOptionsCompat; import android.support.v4.app.Fragment; import android.support.v7.app.AppCompatActivity; import android.util.Log; import android.view.View; import android.widget.Toast; import com.alibaba.android.arouter.demo.module1.testactivity.TestDynamicActivity; import com.alibaba.android.arouter.demo.service.model.TestObj; import com.alibaba.android.arouter.demo.service.model.TestParcelable; import com.alibaba.android.arouter.demo.service.model.TestSerializable; import com.alibaba.android.arouter.demo.service.HelloService; import com.alibaba.android.arouter.demo.module1.testservice.SingleService; import com.alibaba.android.arouter.facade.Postcard; import com.alibaba.android.arouter.facade.callback.NavCallback; import com.alibaba.android.arouter.facade.enums.RouteType; import com.alibaba.android.arouter.facade.model.RouteMeta; import com.alibaba.android.arouter.facade.template.IRouteGroup; import com.alibaba.android.arouter.launcher.ARouter; import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; public class MainActivity extends AppCompatActivity implements View.OnClickListener { @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); } /** * Called when a view has been clicked. * * @param v The view that was clicked. */ @Override public void onClick(View v) { // Build test data. TestSerializable testSerializable = new TestSerializable("Titanic", 555); TestParcelable testParcelable = new TestParcelable("jack", 666); TestObj testObj = new TestObj("Rose", 777); List objList = new ArrayList<>(); objList.add(testObj); Map> map = new HashMap<>(); map.put("testMap", objList); switch (v.getId()) { case R.id.openLog: ARouter.openLog(); // ARouter.printStackTrace(); break; case R.id.openDebug: ARouter.openDebug(); break; case R.id.init: // 调试模式不是必须开启，但是为了防止有用户开启了InstantRun，但是 // 忘了开调试模式，导致无法使用Demo，如果使用了InstantRun，必须在 // 初始化之前开启调试模式，但是上线前需要关闭，InstantRun仅用于开 // 发阶段，线上开启调试模式有安全风险，可以使用BuildConfig.DEBUG // 来区分环境 ARouter.openDebug(); ARouter.init(getApplication()); break; case R.id.normalNavigation: ARouter.getInstance() .build("/test/activity2") .navigation(); // 也可以通过依赖对方提供的二方包来约束入参 // 非必须，可以通过这种方式调用 // Entrance.redirect2Test1Activity("张飞", 48, this); break; case R.id.kotlinNavigation: ARouter.getInstance() .build("/kotlin/test") .withString("name", "老王") .withInt("age", 23) .navigation(); break; case R.id.normalNavigationWithParams: // ARouter.getInstance() // .build("/test/activity2") // .withString("key1", "value1") // .navigation(); Uri testUriMix = Uri.parse("arouter://m.aliyun.com/test/activity2"); ARouter.getInstance().build(testUriMix) .withString("key1", "value1") .navigation(); break; case R.id.oldVersionAnim: ARouter.getInstance() .build("/test/activity2") .withTransition(R.anim.slide_in_bottom, R.anim.slide_out_bottom) .navigation(this); break; case R.id.newVersionAnim: if (Build.VERSION.SDK_INT >= 16) { ActivityOptionsCompat compat = ActivityOptionsCompat. makeScaleUpAnimation(v, v.getWidth() / 2, v.getHeight() / 2, 0, 0); ARouter.getInstance() .build("/test/activity2") .withOptionsCompat(compat) .navigation(); } else { Toast.makeText(this, "API < 16,不支持新版本动画", Toast.LENGTH_SHORT).show(); } break; case R.id.interceptor: ARouter.getInstance() .build("/test/activity4") .navigation(this, new NavCallback() { @Override public void onArrival(Postcard postcard) { } @Override public void onInterrupt(Postcard postcard) { Log.d("ARouter", "被拦截了"); } }); break; case R.id.navByUrl: ARouter.getInstance() .build("/test/webview") .withString("url", "file:///android_asset/scheme-test.html") .navigation(); break; case R.id.autoInject: ARouter.getInstance().build("/test/activity1") .withString("name", "老王") .withInt("age", 18) .withBoolean("boy", true) .withLong("high", 180) .withString("url", "https://a.b.c") .withSerializable("ser", testSerializable) .withParcelable("pac", testParcelable) .withObject("obj", testObj) .withObject("objList", objList) .withObject("map", map) .navigation(); break; case R.id.navByName: ((HelloService) ARouter.getInstance().build("/yourservicegroupname/hello").navigation()).sayHello("mike"); break; case R.id.navByType: ARouter.getInstance().navigation(HelloService.class).sayHello("mike"); break; case R.id.navToMoudle1: ARouter.getInstance().build("/module/1").navigation(); break; case R.id.navToMoudle2: // 这个页面主动指定了Group名 ARouter.getInstance().build("/module/2", "m2").navigation(); break; case R.id.destroy: ARouter.getInstance().destroy(); break; case R.id.failNav: ARouter.getInstance().build("/xxx/xxx").navigation(this, new NavCallback() { @Override public void onFound(Postcard postcard) { Log.d("ARouter", "找到了"); } @Override public void onLost(Postcard postcard) { Log.d("ARouter", "找不到了"); } @Override public void onArrival(Postcard postcard) { Log.d("ARouter", "跳转完了"); } @Override public void onInterrupt(Postcard postcard) { Log.d("ARouter", "被拦截了"); } }); break; case R.id.callSingle: ARouter.getInstance().navigation(SingleService.class).sayHello("Mike"); break; case R.id.failNav2: ARouter.getInstance().build("/xxx/xxx").navigation(); break; case R.id.failNav3: ARouter.getInstance().navigation(MainActivity.class); break; case R.id.normalNavigation2: ARouter.getInstance() .build("/test/activity2") .navigation(this, 666); break; case R.id.getFragment: Fragment fragment = (Fragment) ARouter.getInstance().build("/test/fragment") .withString("name", "老王") .withInt("age", 18) .withBoolean("boy", true) .withLong("high", 180) .withString("url", "https://a.b.c") .withSerializable("ser", testSerializable) .withParcelable("pac", testParcelable) .withObject("obj", testObj) .withObject("objList", objList) .withObject("map", map).navigation(); Toast.makeText(this, "找到Fragment:" + fragment.toString(), Toast.LENGTH_SHORT).show(); break; case R.id.addGroup: ARouter.getInstance().addRouteGroup(new IRouteGroup() { @Override public void loadInto(Map atlas) { atlas.put("/dynamic/activity", RouteMeta.build( RouteType.ACTIVITY, TestDynamicActivity.class, "/dynamic/activity", "dynamic", 0, 0)); } }); break; case R.id.dynamicNavigation: // 该页面未配置 Route 注解，动态注册到 ARouter ARouter.getInstance().build("/dynamic/activity") .withString("name", "老王") .withInt("age", 18) .withBoolean("boy", true) .withLong("high", 180) .withString("url", "https://a.b.c") .withSerializable("ser", testSerializable) .withParcelable("pac", testParcelable) .withObject("obj", testObj) .withObject("objList", objList) .withObject("map", map).navigation(this); break; default: break; } } @Override protected void onActivityResult(int requestCode, int resultCode, Intent data) { super.onActivityResult(requestCode, resultCode, data); switch (requestCode) { case 666: Log.e("activityResult", String.valueOf(resultCode)); break; default: break; } } } ================================================ FILE: app/src/main/java/com/alibaba/android/arouter/demo/SchemeFilterActivity.java ================================================ package com.alibaba.android.arouter.demo; import android.app.Activity; import android.net.Uri; import android.os.Bundle; import com.alibaba.android.arouter.facade.Postcard; import com.alibaba.android.arouter.facade.callback.NavCallback; import com.alibaba.android.arouter.launcher.ARouter; public class SchemeFilterActivity extends Activity { @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); // 直接通过ARouter处理外部Uri Uri uri = getIntent().getData(); ARouter.getInstance().build(uri).navigation(this, new NavCallback() { @Override public void onArrival(Postcard postcard) { finish(); } }); } } ================================================ FILE: app/src/main/res/anim/slide_in_bottom.xml ================================================ ================================================ FILE: app/src/main/res/anim/slide_out_bottom.xml ================================================ ================================================ FILE: app/src/main/res/drawable/bg_test_area.xml ================================================ ================================================ FILE: app/src/main/res/layout/activity_main.xml ================================================