React Native填坑之旅 -- FlatList

在React Native裏有很多種方法來創建可滾動的list。比如，ScrollView和ListView。他們都各有優缺點。但是在React Native 0.43裏增加了兩種行的list view。一個是FlatList, 一個是SectionList。今天我們就來詳細瞭解一下FlatList。

如果你熟悉RN之前的ListView的話你會發現FlatList的API更加的簡單，只需要給它一列數據，然後根據每一項數據繪製行就可以。

源代碼在github上。代碼中使用的是RN 0.49.5。

基本使用方法

基本上你只要給FlatList的兩個props指定值就可以了，一個是data，一個是renderItem。數據源一般就是一個數組，而renderItem就是每一行的繪製方法。繪製行的時候只需要獲取當前的數據項就可以。

正式開始之前，我們看下代碼是什麼樣子的。

import React from 'react';
import {
  View,
  Text,
  FlatList,
  Dimensions,
} from 'react-native';

import MessageCell from './MessageCell';

const { width, height } = Dimensions.get('window');
const SCREEN_WIDTH = width;

export default class MessageContainer extends React.Component {
  constructor(props) {
    super(props);

    this.state = {
      error: false,
      page: 1,
      refreshing: false,
      loading: false,
      data: {},
    };
  }

  componentDidMount() {
    this.requestData();
  }

  requestData = () => {
    const url = 'Some rest api url address';
    fetch(url).then(res => {    
      return res.json()
    }).then(res => {
      this.setState({
        data: [...this.state.data, ...res],
      });
    }).catch(err => {
      this.setState({ error: err, loading: false, refreshing: false});
    });
  };

  render() {
    return (
      <View style={{ flex: 1, justifyContent: 'center', alignItems: 'stretch', backgroundColor: 'white' }}>
        <Text>Message</Text>
        <FlatList
          data={[{ key: 'a' }, { key: 'b' }, { key: 'c' }, { key: 'd' }]}
          renderItem={({ item }) => (
            <MessageCell item={item} />
          )} />
      </View>
    );
  }
}

首先import必要的組件：import { FlatList } from 'react-native';。當然還有其他的一些組件。render方法裏就可以寫繪製的代碼了:

render() {
    return (
      <View style={...}>
        <Text>Message</Text>
        <FlatList
          data={this.state.data}
          renderItem={({ item }) => (
            <MessageCell item={item} />
          )} />
      </View>
    );
  }

data是從github的API上請求來的數據，json數據被解析之後填充到了this.state.data裏。就像這樣：data: [...this.state.data, ...res]。每個元素是一個只有一個key鍵值的對象。renderItem方法裏會根據每一個item返回一個MessageCell組件。這個組件會根據傳入的數據呈現不同的內容。

每行需要一個key

React Native爲了很快的達到重繪改變了的一組組件，規定要給這一組組件裏的每一個都設置一個key。FlatList的每一行也都需要一個key。

我們可以直接設置一個key。比如，每個元素的返回json裏都有一個id屬性，正好就可以用來作爲每一行的key值。FlatList還有另外的一個設置方式.使用keyExtractor。

  render() {
    return (
      <View style={styles.container}>
        <Text>Message</Text>
        <FlatList
          ...
          keyExtractor={item => item.id} />
      </View>
    );

分割線 - seperator

我們的APP本身在顯示message的時候沒有明顯的分割線，而是用一塊一塊的方式顯示的。如果只是簡單的一條線分割兩行，那麼只需要設置行組件的boderBottom相關的屬性就可以了。
如設置行組件的borderBottom：

<View style={ borderTopWidth: 0, borderBottomWidth: 1, borderBottomColor: 'grey' }>
  // content...
</View>

如果你一定要一個分割線的話可以使用FlatList的ItemSeperatorComponent prop。如：

  renderSeparator = () => {
    return (
        <View
        style={{
        height: 1,
        width: "86%",
        backgroundColor: "#CED0CE",
        marginLeft: "14%"
        }}
        />
    );
  };

使用seperator：

render() {
  return (
    <List containerStyle={{ borderTopWidth: 0, borderBottomWidth: 0 }}>
      <FlatList
        ...
        ItemSeparatorComponent={this.renderSeparator}
      />
    </List>
  );
}

在FlatList裏使用prop ItemSeparatorComponent就可以。

注意：list的頂部和底部的分割組件是不繪製的。

下拉刷新和上拉加載更多

自從這兩個交互的方式自從發明出來之後就基本上是每一個應用裏list的標配了。我們來看看FlatList如何添加這兩個功能的。

  render() {
    return (
      <View style={styles.container}>
        <Text>Message</Text>
        <FlatList
          ...
          refreshing={this.state.refreshing}
          onRefresh={this.handleRefresh}
          onEndReached={this.handleLoadMore}
          onEndReachedThreshold={0} />
      </View>
    );
  }

FlatList的幾個props：
refreshing：表明list是否在refresh的狀態。
onRefresh：開始refresh的事件。在這個方法裏開始設置refresh的時候組件的state，並在setState方法的回調裏開始請求後端的數據。
onEndReached: 上拉加載跟個多的事件。在這裏設置加載更多對應的組件狀態，並在setState方法的回調裏請求後端數據。
onEndReachedThreshold：這個值是觸發onEndReached方法的閾值。值是RN的邏輯像素。

下面看一下下拉刷新的方法。上拉加載更多基本類似，各位可以參考代碼。

  handleRefresh = () => {
    this.setState({
      page: 1,
      refreshing: true,
      loading: false,
      data: [],
    }, () => {
      this.requestData();
    });
  }

請求github的API的方法是：

  requestData = () => {
    const url = 'https://api.github.com/users/[your github name]/repos';
    fetch(url).then(res => {
      console.log('started fetch');
      return res.json()
    }).then(res => {
      this.setState({
        data: [...this.state.data, ...res], 
        error: res.error || null,
        laoding: false,
        refreshing: false,
      });
    }).catch(err => {
      console.log('==> fetch error', err);
      this.setState({ error: err, loading: false, refreshing: false});
    });
  }

在下拉刷新開始請求後端的數據的時候首先設置組件狀態。給組件的state設置初始值。

下拉刷新的話，每次都會清空已經存在的數據，並在之後給他設置爲獲得的第一頁（或者）最新的數據，所以page:1。接下來要開始刷新，那麼表示刷新的小菊花就需要轉起來，所以refreshing的值設爲true。loading在這個時候是不存在的，所以爲false。

在setState方法的回調裏開始請求後端的數據。數據返回之後，下拉刷新或者加載更多的狀態都不存在。如果請求數據的時候有錯，那麼我們要處理錯誤。所以秦秋網絡數據的方法爲：

  requestData = () => {
    const url = 'https://api.github.com/users/futurechallenger/repos';
    fetch(url).then(res => {
      console.log('started fetch');
      return res.json()
    }).then(res => {
      this.setState({
        data: [...this.state.data, ...res], 
        error: res.error || null,
        laoding: false,
        refreshing: false,
      });
    }).catch(err => {
      console.log('==> fetch error', err);
      this.setState({ error: err, loading: false, refreshing: false});
    });
  }

在返回的數據轉化爲json格式之後，合成data。這個時候refreshing和loading都已經完成，值都設置爲false。數據是累加的：data: [...this.state.data, ...res],，所以每次在下拉刷新的時候this.setState({data: []})，在上拉加載更多的時候可以留着data不置空。

List的header和footer

這個非常的簡單，只要直接看代碼就可以明白了。和使用prop renderItem一樣的，header和footer都有對應的prop來繪製。

  // Header
  renderHeader = () => {
    return <SearchBar placeholder="Type Here..." lightTheme round />;
  };

  // Footer
  renderFooter = () => {
    if (!this.state.loading) return null;

    return (
      <View
        style={{
          paddingVertical: 20,
          borderTopWidth: 1,
          borderColor: "#CED0CE"
        }}
      >
        <ActivityIndicator animating size="large" />
      </View>
    );
  };

然後這麼用：

render() {
  return (
    <List containerStyle={{ borderTopWidth: 0, borderBottomWidth: 0 }}>
      <FlatList
        ...
        ListHeaderComponent={this.renderHeader}
        ListFooterComponent={this.renderFooter}
      />
    </List>
  );
}

希望這些對你們有用。