一、描述

FlatMap将一个发射数据的Observable变换为多个Observables，然后将它们发射的数据合并后放进一个单独的Observable。

FlatMap操作符使用一个指定的函数对原始Observable发射的每一项数据执行变换操作，这个函数返回一个本身也发射数据的Observable，然后FlatMap合并这些Observables发射的数据，最后将合并后的结果当做它自己的数据序列发射。

这个方法是很有用的，例如，当你有一个这样的Observable：它发射一个数据序列，这些数据本身包含Observable成员或者可以变换为Observable，因此你可以创建一个新的Observable发射这些次级Observable发射的数据的完整集合。

注意：FlatMap对这些Observables发射的数据做的是合并(merge)操作，因此它们可能是交错的。

在许多语言特定的实现中，还有一个操作符不会让变换后的Observables发射的数据交错，它按照严格的顺序发射这些数据，这个操作符通常被叫作ConcatMap或者类似的名字。

注意：如果任何一个通过这个flatMap操作产生的单独的Observable调用onError异常终止了，这个Observable自身会立即调用onError并终止。

二、示意图

flatMap

三、示例代码

class Course {
    private String name;

    public Course(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }
}

class Student {
    private List<Course> courses;

    public Student(List<Course> courses) {
        this.courses = courses;
    }

    public List<Course> getCourses() {
        return courses;
    }
}

/* Student1 */
Course course11 = new Course("C#");
Course course12 = new Course("Java");
Course course13 = new Course("Python");

List<Course> courses1 = new ArrayList<Course>();
courses1.add(course11);
courses1.add(course12);
courses1.add(course13);

Student student1 = new Student(courses1);

/* Student2 */
Course course21 = new Course("OC");
Course course22 = new Course("Ruby");

List<Course> courses2 = new ArrayList<Course>();
courses2.add(course21);
courses2.add(course22);

Student student2 = new Student(courses2);

Observable.just(student1, student2)
    .flatMap(new Func1<Student, Observable<Course>>() {
        @Override
        public Observable<Course> call(Student student) {
            return Observable.from(student.getCourses());
        }
    })
    .subscribe(new Subscriber<Course>() {
        @Override
        public void onCompleted() {
            System.out.println("onCompleted.");
        }

        @Override
        public void onError(Throwable e) {
            System.out.println("onError: " + e.getMessage());
        }

        @Override
        public void onNext(Course course) {
            System.out.println("onNext: " + course.getName());
        }
    });

四、运行结果

onNext: C#
onNext: Java
onNext: Python
onNext: OC
onNext: Ruby
onCompleted.

项目代码已上传到Github：https://github.com/SherlockShi/RxJavaBestPractise

五、更多

flatMap操作符共有以下几个变体：

flatMap(Func1)
flatMap(Func1,int)
flatMap(Func1,Func1,Func0)
flatMap(Func1,Func1,Func0,int)
flatMap(Func1,Func2)
flatMap(Func1,Func2,int)

跟flatMap相关的操作符还有：

flatMapIterable
concatMap
switchMap
split

详情可查阅下面的参考资料。

六、参考资料

ReactiveX官方文档

ReactiveX文档中文翻译

PS：欢迎关注 SherlockShi 个人博客