Skip to content

Latest commit

 

History

History
233 lines (158 loc) · 11.4 KB

README_ZH.md

File metadata and controls

233 lines (158 loc) · 11.4 KB
Raw

RxImagePicker

English Documentation | 中文文档

(RxJava3) (RxJava2)

通知（重要）

自2.3.0版本之后，库只提供对官方AndroidX的支持，详情请参考Android官方文档AndroidX Overview.

RxImagePicker提供了对RxJava2和RxJava3的支持：

  • 2.x版本: Kotlin实现，支持AndroidX和RxJava2;
  • 3.x版本: Kotlin实现，支持AndroidX和RxJava3;

最新版本号请参考顶部标签信息。

简介

RxImagePicker存在的目的是：让开发者能够简单并且灵活的方式实现Android开发中图片选择的需求。

它与传统的其他三方的图片选择库不同的是，后者通过跳转到固定的Activity进行图片选择，并不能满足所有应用的需求；以QQ聊天会话界面的图片选择功能为例，这种特殊的UI需求很难依靠图片选择库实现，开发者只能去自己实现。

一旦和目前项目的需求有了冲突（修改或者添加），开发者考虑的不应该是【这个库实现不了，干脆换一个库吧】或者【不管这个库，我去再单独实现一个】，而是，基于同一个图片选择框架，修改或者添加对应配置的接口。

screenshot_qq

RxImagePicker是一个用于Android的响应式图片选择器，它将您的图片选择需求转换为一个接口进行配置，并在任何一个Activity或者Fragment中展示任何样式的图片选择UI。

RxImagePicker的设计起源，请参考：

RxImagePicker:从零实现灵活且可高度定制的Android图片选择架构

RxImagePicker的UI自动化测试，请参考：

全副武装！AndroidUI自动化测试在RxImagePicker中的实践历程

支持的功能

  • Android Camera拍照
  • Android 图片选择
  • 以响应式数据流的格式返回数据（支持Observable/Flowable/Single/Maybe）
  • 支持拓展数据，比如用于实现微信 发送原图 等功能，完全由您自定义灵活进行配置
  • 覆盖全面的UI自动化测试，详见下方示例截图。
  • 对AndroidX的支持（after v2.3.0+）。

UI的支持

除了Android系统默认的图片选择样式，你可以选择使用这些额外的UI支持：

  • 系统级别图片选择器
  • 知乎主题图片选择器
  • 微信主题图片选择器
  • 自定义UI图片选择器

示例截图

系统图片选择和结果展示

知乎主题

微信主题

想要 快速实现上图所示效果 请点击这里查看wiki中的详细文档。

UI自动化测试

测试代码的覆盖，保证了每个新版本的稳定性，以及程序的健壮性。

基础使用

1. 添加依赖在Module的build.gradle文件中：

如果您的项目已经迁移了AndroidX，建议依赖最新版本,last_version版本号请参考文档顶部版本信息标签；

// 最基础的架构，仅提供了系统默认的图片选择和拍照功能
compile 'com.github.qingmei2:rximagepicker:${last_version}'

// 提供了自定义UI图片选择器的基本组件，自定义UI的需求需要添加该依赖
compile 'com.github.qingmei2:rximagepicker_support:${last_version}'

// 如果需要额外的UI支持，请选择依赖对应的UI拓展库
compile 'com.github.qingmei2:rximagepicker_support_zhihu:${last_version}'     // 知乎图片选择器
compile 'com.github.qingmei2:rximagepicker_support_wechat:${last_version}'    // 微信图片选择器

如果您的项目没有迁移AndroidX(即v7包的包名是com.android.support而非androidx.appcompat),请继续使用2.2.0的稳定版本，否则包名不同会导致编译错误！

2. 接口配置

声明一个接口，并进行基础的配置：

public interface MyImagePicker {

    @Gallery    // 打开相册选择图片
    Observable<Result> openGallery(Context context);

    @Camera     // 打开相机拍照
    Observable<Result> openCamera(Context context);
}

3. 实例化接口并使用它

在您的Activity或者Fragment中实例化该接口，以打开系统默认的相册/相机界面：

//打开系统默认的图片选择器
private void onButtonClick() {
    RxImagePicker
            .create(MyImagePicker.class)
            .openGallery(this)
            .subscribe(new Consumer<Result>() {
                @Override
                public void accept(Result result) throws Exception {
                    Uri uri = result.getUri();
                    // 对图片进行处理，比如加载到ImageView中
                    GlideApp.with(this)
                             .load(uri)
                             .into(ivPickedImage);
                }
            });
}

详细文档

关于RxImagePicker更详细的使用说明，进阶使用和拓展功能,请参考wiki！

更多疑问

如果对于RxImagePicker的使用有疑问或者建议，请提issue.

其他RxJava项目

参考

在 RxImagePicker 的设计过程中，我参考了很多的三方库，它们源码中优秀的 设计思想 或者 架构设计 ，都给与了我很大的启示，在此深表感谢，感谢诸多开源爱好者前辈们的无私精神：

混淆

-keep class com.qingmei2.rximagepicker.**{*;}

Contributors

License

The RxImagePicker：MIT License

Copyright (c) 2018 qingmei2

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.