ReactNative 之FlatList踩坑封裝總結

在RN中FlatList是一個高性能的列表組件,它是ListView組件的升級版,性能方面有了很大的提升,當然也就建議大家在實現列表功能時使用FlatList,盡量不要使用ListView,更不要使用ScrollView。既然說到FlatList,那就先溫習一下它支持的功能。

  • 完全跨平臺。

  • 支持水平布局模式。

  • 行組件顯示或隱藏時可配置回調事件。

  • 支持單獨的頭部組件。

  • 支持單獨的尾部組件。

  • 支持自定義行間分隔線。

  • 支持下拉刷新。

  • 支持上拉加載。

  • 支持跳轉到指定行(ScrollToIndex)。

今天的這篇文章不具體介紹如何使用,如果想看如何使用,可以參考我GitHub https://github.com/xiehui999/helloReactNative的一些示例。今天的這篇文章主要介紹我使用過程中感覺比較大的坑,并對FlatList進行的二次封裝。
接下來,我們先來一個簡單的例子。我們文章也有這個例子開始探討。

        <FlatList
            data={this.state.dataList} extraData={this.state}
            refreshing={this.state.isRefreshing}
            onRefresh={() => this._onRefresh()}
            keyExtractor={(item, index) => item.id}
            ItemSeparatorComponent={() => <View style={{
                height: 1,
                backgroundColor: '#D6D6D6'
            }}/>}
            renderItem={this._renderItem}
            ListEmptyComponent={this.emptyComponent}/>
            
            
    //定義空布局
        emptyComponent = () => {
        return <View style={{
            height: '100%',
            alignItems: 'center',
            justifyContent: 'center',
        }}>
            <Text style={{
                fontSize: 16
            }}>暫無數據下拉刷新</Text>
        </View>
    }

在上面的代碼,我們主要看一下ListEmptyComponent,它表示沒有數據的時候填充的布局,一般情況我們會在中間顯示顯示一個提示信息,為了介紹方便就簡單展示一個暫無數據下拉刷新。上面代碼看起來是暫無數據居中顯示,但是運行后,你傻眼了,暫無數據在最上面中間顯示,此時高度100%并沒有產生效果。當然你嘗試使用flex:1,將View的高視圖填充剩余全屏,不過依然沒有效果。

那為什么設置了沒有效果呢,既然好奇,我們就來去源碼看一下究竟。源碼路徑在react-native-->Libraries-->Lists。列表的組件都該目錄下。我們先去FlatList文件搜索關鍵詞ListEmptyComponent,發現該組件并沒有被使用,那就繼續去render


  render() {
    if (this.props.legacyImplementation) {
      return (
        <MetroListView
          {...this.props}
          items={this.props.data}
          ref={this._captureRef}
        />
      );
    } else {
      return (
        <VirtualizedList
          {...this.props}
          renderItem={this._renderItem}
          getItem={this._getItem}
          getItemCount={this._getItemCount}
          keyExtractor={this._keyExtractor}
          ref={this._captureRef}
          onViewableItemsChanged={
            this.props.onViewableItemsChanged && this._onViewableItemsChanged
          }
        />
      );
    }
  }

MetroListView(內部實行是ScrollView)是舊的ListView實現方式,VirtualizedList是新的性能比較好的實現。我們去該文件

    //省略部分代碼
    const itemCount = this.props.getItemCount(data);
    if (itemCount > 0) {
        ....省略部分代碼
    } else if (ListEmptyComponent) {
      const element = React.isValidElement(ListEmptyComponent)
        ? ListEmptyComponent // $FlowFixMe
        : <ListEmptyComponent />;
      cells.push(
        /* $FlowFixMe(>=0.53.0 site=react_native_fb,react_native_oss) This
         * comment suppresses an error when upgrading Flow's support for React.
         * To see the error delete this comment and run Flow. */
        <View
          key="$empty"
          onLayout={this._onLayoutEmpty}
          style={inversionStyle}>
          {element}
        </View>,
      );
    }

再此處看到我們定義的ListEmptyComponent外面包了一層view,該view加了樣式inversionStyle。

const inversionStyle = this.props.inverted
      ? this.props.horizontal
        ? styles.horizontallyInverted
        : styles.verticallyInverted
      : null;
      
樣式:
verticallyInverted: {
    transform: [{scaleY: -1}],
  },
 horizontallyInverted: {
    transform: [{scaleX: -1}],
  },

上面的樣式就是添加了一個動畫,并沒有設置高度,所以我們在ListEmptyComponent使用height:'100%'或者flex:1都沒有效果,都沒有撐起高度。

為了實現我們想要的效果,我們需要將height設置為具體的值。那么該值設置多大呢?你如果給FlatList設置一個樣式,背景屬性設置一個顏色,發現FlatList是默認有占滿剩余屏的高度的(flex:1)。那么我們可以將ListEmptyComponent中view的高度設置為FlatList的高度,要獲取FlatList的高度,我們可以通過onLayout獲取。
代碼調整:

//創建變量
fHeight = 0;

        <FlatList
            data={this.state.dataList} extraData={this.state}
            refreshing={this.state.isRefreshing}
            onRefresh={() => this._onRefresh()}
            keyExtractor={(item, index) => item.id}
            ItemSeparatorComponent={() => <View style={{
                height: 1,
                backgroundColor: '#D6D6D6'
            }}/>}
            renderItem={this._renderItem}
            onLayout={e => this.fHeight = e.nativeEvent.layout.height}
            ListEmptyComponent={this.emptyComponent}/>
            
            
    //定義空布局
        emptyComponent = () => {
        return <View style={{
            height: this.fHeight,
            alignItems: 'center',
            justifyContent: 'center',
        }}>
            <Text style={{
                fontSize: 16
            }}>暫無數據</Text>
        </View>
    }

通過上面的調整發現在Android上運行時達到我們想要的效果了,但是在iOS上,不可控,偶爾居中顯示,偶爾又顯示到最上面。原因就是在iOS上onLayout調用的時機與Android略微差別(iOS會出現emptyComponent渲染時onLayout還沒有回調,此時fHeight還沒有值)。

所以為了將變化后的值作用到emptyComponent,我們將fHeight設置到state中

state={
    fHeight:0
}

onLayout={e => this.setState({fHeight: e.nativeEvent.layout.height})}

這樣設置后應該完美了吧,可是....在android上依然能完美實現我們要的效果,在iOS上出現了來回閃屏的的問題。打印log發現值一直是0和測量后的值來回轉換。在此處我們僅僅需要是測量的值,所以我們修改onLayout

                      onLayout={e => {
                          let height = e.nativeEvent.layout.height;
                          if (this.state.fHeight < height) {
                              this.setState({fHeight: height})
                          }
                      }}

經過處理后,在ios上終于完美的實現我們要的效果了。

除了上面的坑之外,個人感覺還有一個坑就是onEndReached,如果我們實現下拉加載功能,都會用到這個屬性,提到它我們當然就要提到onEndReachedThreshold,在FlatList中onEndReachedThreshold是一個number類型,是一個他表示具體底部還有多遠時觸發onEndReached,需要注意的是FlatList和ListView中的onEndReachedThreshold表示的含義是不同的,在ListView中onEndReachedThreshold表示具體底部還有多少像素時觸發onEndReached,默認值是1000。而FlatList中表示的是一個倍數(也稱比值,不是像素),默認值是2。
那么按照常規我們看下面實現

            <FlatList
                data={this.state.dataList}
                extraData={this.state}
                refreshing={this.state.isRefreshing}
                onRefresh={() => this._onRefresh()}
                ItemSeparatorComponent={() => <View style={{
                    height: 1,
                    backgroundColor: '#D6D6D6'
                }}/>}
                renderItem={this._renderItem}
                ListEmptyComponent={this.emptyComponent}
                onEndReached={() => this._onEndReached()}
                onEndReachedThreshold={0.1}/>

然后我們在componentDidMount中加入下面代碼

    componentDidMount() {
        this._onRefresh()
    }

也就是進入開始加載第一頁數據,下拉的執行onEndReached加載更多數據,并更新數據源dataList。看起來是完美的,不過.....運行后你會發現onEndReached一直循環調用(或多次執行),有可能直到所有數據加載完成,原因可能大家也能猜到了,因為_onRefresh加載數據需要時間,在數據請求到之前render方法執行,由于此時沒有數據,onEndReached方法執行一次,那么此時相當于加載了兩次數據。

至于onEndReached執行多少次就需要onEndReachedThreshold的值來定了,所以我們一定要慎重設置onEndReachedThreshold,如果你要是理解成了設置像素,設置成了一個比較大的數,比如100,那完蛋了....個人感覺設置0.1是比較好的值。

通過上面的分析,個人感覺有必要對FlatList進行一次二次封裝了,根據自己的需求我進行了一次二次封裝

import React, {
    Component,
} from 'react'
import {
    FlatList,
    View,
    StyleSheet,
    ActivityIndicator,
    Text
} from 'react-native'
import PropTypes from 'prop-types';

export const FlatListState = {
    IDLE: 0,
    LoadMore: 1,
    Refreshing: 2
};
export default class Com extends Component {
    static propTypes = {
        refreshing: PropTypes.oneOfType([PropTypes.bool, PropTypes.number]),
    };
    state = {
        listHeight: 0,
    }

    render() {
        var {ListEmptyComponent,ItemSeparatorComponent} = this.props;
        var refreshing = false;
        var emptyContent = null;
        var separatorComponent = null
        if (ListEmptyComponent) {
            emptyContent = React.isValidElement(ListEmptyComponent) ? ListEmptyComponent : <ListEmptyComponent/>
        } else {
            emptyContent = <Text style={styles.emptyText}>暫無數據下拉刷新</Text>;
        }
        if (ItemSeparatorComponent) {
            separatorComponent = React.isValidElement(ItemSeparatorComponent) ? ItemSeparatorComponent :
                <ItemSeparatorComponent/>
        } else {
            separatorComponent = <View style={{height: 1, backgroundColor: '#D6D6D6'}}/>;
        }
        if (typeof this.props.refreshing === "number") {
            if (this.props.refreshing === FlatListState.Refreshing) {
                refreshing = true
            }
        } else if (typeof this.props.refreshing === "boolean") {
            refreshing = this.props.refreshing
        } else if (typeof this.props.refreshing !== "undefined") {
            refreshing = false
        }
        return <FlatList
            {...this.props}
            onLayout={(e) => {
                let height = e.nativeEvent.layout.height;
                if (this.state.listHeight < height) {
                    this.setState({listHeight: height})
                }
            }
            }
            ListFooterComponent={this.renderFooter}
            onRefresh={this.onRefresh}
            onEndReached={this.onEndReached}
            refreshing={refreshing}
            onEndReachedThreshold={this.props.onEndReachedThreshold || 0.1}
            ItemSeparatorComponent={()=>separatorComponent}
            keyExtractor={(item, index) => index}
            ListEmptyComponent={() => <View
                style={{
                    height: this.state.listHeight,
                    width: '100%',
                    alignItems: 'center',
                    justifyContent: 'center'
                }}>{emptyContent}</View>}
        />
    }

    onRefresh = () => {
        console.log("FlatList:onRefresh");
        if ((typeof  this.props.refreshing === "boolean" && !this.props.refreshing) ||
            typeof  this.props.refreshing === "number" && this.props.refreshing !== FlatListState.LoadMore &&
            this.props.refreshing !== FlatListState.Refreshing
        ) {
            this.props.onRefresh && this.props.onRefresh()
        }

    };
    onEndReached = () => {
        console.log("FlatList:onEndReached");
        if (typeof  this.props.refreshing === "boolean" || this.props.data.length == 0) {
            return
        }
        if (!this.props.pageSize) {
            console.warn("pageSize must be set");
            return
        }
        if (this.props.data.length % this.props.pageSize !== 0) {
            return
        }
        if (this.props.refreshing === FlatListState.IDLE) {
            this.props.onEndReached && this.props.onEndReached()
        }
    };


    renderFooter = () => {
        let footer = null;
        if (typeof this.props.refreshing !== "boolean" && this.props.refreshing === FlatListState.LoadMore) {
            footer = (
                <View style={styles.footerStyle}>
                    <ActivityIndicator size="small" color="#888888"/>
                    <Text style={styles.footerText}>數據加載中…</Text>
                </View>
            )
        }
        return footer;
    }
}
const styles = StyleSheet.create({
    footerStyle: {
        flex: 1,
        flexDirection: 'row',
        justifyContent: 'center',
        alignItems: 'center',
        padding: 10,
        height: 44,
    },
    footerText: {
        fontSize: 14,
        color: '#555555',
        marginLeft: 7
    },
    emptyText: {
        fontSize: 17,
        color: '#666666'
    }
})

propTypes中我們使用了oneOfType對refreshing類型進行限定,如果ListEmptyComponent有定義,就是使用自定義分View,同理ItemSeparatorComponent也可以自定義。

在下拉加載數據時定義了一個ListFooterComponent,用于提示用戶正在加載數據,refreshing屬性如果是boolean的話,表示沒有下拉加載功能,如果是number類型,pageSize必須傳,數據源長度與pageSize取余是否等于0,判斷是否有更多數據(最后一次請求的數據等于pageSize時才有更多數據,小于就不用回調onEndReached)。當然上面的代碼也很簡單,相信很容易看懂,其它就不多介紹了。有問題歡迎指出。源碼地址

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,316評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,481評論 3 415
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,241評論 0 374
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,939評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,697評論 6 409
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,182評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,247評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,406評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,933評論 1 334
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,772評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,973評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,516評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,209評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,638評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,866評論 1 285
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,644評論 3 391
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,953評論 2 373

推薦閱讀更多精彩內容

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,636評論 25 708
  • 簡介:百度圖片相信大家都不會陌生,但是里面的布局實現效果確很麻煩。它是通過JS實現的,過程也相當麻煩。不要捉急,我...
    小碼哥教育520it閱讀 1,316評論 0 0
  • 哈哈哈
    煮字人閱讀 217評論 0 0