react動畫開源庫代碼學(xué)習(xí)之rc-animate

rc-animate

rc-animate是這個庫在npm上的名字夏漱,他在github搜索的話得用animate去搜索豪诲。(下面就都簡稱為animate了)
animate是阿里的庫,ant-design也是使用的他完成動畫的一部分內(nèi)容挂绰。
官網(wǎng)是這樣介紹的:

對單個元素根據(jù)狀態(tài)進(jìn)行動畫顯示隱藏屎篱,需結(jié)合 css 或其它第三方動畫類一起使用

代碼結(jié)構(gòu)

code.PNG

rc-animate的源代碼src文件夾下只有Animate,AnimateChild葵蒂,ChildrenUtils交播,Utils這四個js文件,后兩個utils是工具類js践付,用來檢測組件的props是否含有某個值這樣的工作等秦士,不過多介紹。
Animate.js是我們庫暴露給我們使用的組件永高,他會在內(nèi)部做一些檢測隧土,回調(diào)等等操作。然后調(diào)用AnimateChild組件命爬,AnimateChild是實際實現(xiàn)動畫的地方曹傀。AnimateChild中使用了css-animate這個庫,css-animate才是最核心的操作遇骑,他將給dom元素添加指定的css類名卖毁。另一個animateUtils是上一層的utils.js這個文件,我寫錯了落萎,這里說明一下亥啦。
先從rc-animate的最外層,我們最先接觸到的Animate.js講起练链。

Animate.js

簡書上寫大段的代碼太費(fèi)勁了翔脱,我就一小段一小段的解釋吧。

constructor

這個沒什么難點媒鼓,就是普通的初始化届吁。currentlyAnimatingKeys和childrenRefs在后續(xù)會比較重要,使用次數(shù)比較多

constructor(props) {
  super(props);
  // 這個數(shù)組用來儲存正在進(jìn)行動畫的dom節(jié)點的key值
  this.currentlyAnimatingKeys = {};
  // 這兩個數(shù)組就顧名思義啦
  this.keysToEnter = [];
  this.keysToLeave = [];
  this.state = {
    // 這里的toArrayChildren和getChildrenFromProps都是上面講的兩個工具類里的工具方法
    children: toArrayChildren(getChildrenFromProps(props)),
  };
  // 儲存ref
  this.childrenRefs = {};
}

componentDidMount

componentDidMount() {
  const showProp = this.props.showProp;
  let children = this.state.children;
  // showProp是Animate組件提供的一個API绿鸣,原文解釋為:'子級動畫的類型疚沐,顯示或隱藏'
  // 完全不理解他的意思,剛好官網(wǎng)的代碼示例也沒有用帶這個參數(shù)潮模,我們就暫且跳過他亮蛔,給他一個null值吧
  if (showProp) {
    children = children.filter((child) => {
      return !!child.props[showProp];
    });
  }
  // 遍歷子節(jié)點,并調(diào)用performAppear方法擎厢,這個方法名翻譯一下就是:‘執(zhí)行顯示’究流,所以這就是我們的css效果的第一個觸發(fā)點
  // 完成組件掛載后辣吃,讓組件執(zhí)行css動畫,也就是常見的淡入效果之類的芬探。
  children.forEach((child) => {
    if (child) {
      this.performAppear(child.key);
    }
  });
}

performAppear

performAppear這個方法是Animate組件自己的實例方法

performAppear = (key) => {
  if (this.childrenRefs[key]) {
    // 用key值找到目標(biāo)組件神得,然后對currentlyAnimatingKeys數(shù)組做一個標(biāo)識,告訴大家偷仿,這個組件正在進(jìn)行動畫
    this.currentlyAnimatingKeys[key] = true;
    // 調(diào)用實例上的方法哩簿,這個componentWillAppear方法,是Ref對應(yīng)的實例自己提供的一個實例方法(這里實例對應(yīng)的Class是AnimateChild)
   // 可以將componentWillAppear理解為AnimateChild的一個生命周期函數(shù)炎疆,Animate就是執(zhí)行這個生命周期函數(shù)的框架
  // 傳遞給可以將componentWillAppear的方法是一個回調(diào)函數(shù)
    this.childrenRefs[key].componentWillAppear(
      this.handleDoneAdding.bind(this, key, 'appear')
    );
  }
}

我想按照調(diào)用組件時代碼的執(zhí)行順序來梳理整個庫的代碼卡骂,所以接下來不一一說明Animate類里的方法了,而是講他的render函數(shù)與AnimateChild.js的內(nèi)容

render

    render() {
      const props = this.props;
      this.nextProps = props;
      const stateChildren = this.state.children;
      let children = null;
      // 先map拿到被AnimateChild包裝好的組件數(shù)組
      if (stateChildren) {
        children = stateChildren.map((child) => {
          if (child === null || child === undefined) {
            return child;
          }
          if (!child.key) {
            throw new Error('must set key for <rc-animate> children');
          }
          // 返回的AnimateChild組件形入,childrenRefs數(shù)組里儲存的就是AnimateChild組件的實例
          return (
            <AnimateChild
              key={child.key}
              ref={node => this.childrenRefs[child.key] = node}
              animation={props.animation}
              transitionName={props.transitionName}
              transitionEnter={props.transitionEnter}
              transitionAppear={props.transitionAppear}
              transitionLeave={props.transitionLeave}
            >
              {child}
            </AnimateChild>
          );
        });
      }
      const Component = props.component;
      // 這個component是暴露出來的api,用來指定需要替換的標(biāo)簽
      // 這里可以看到缝左,如果沒有component的話亿遂,會只渲染組件數(shù)組的第一項
      // 有component則會全部渲染,因該是為了保證有一個父級節(jié)點去包裹渺杉,以便進(jìn)行動畫
      if (Component) {
        let passedProps = props;
        if (typeof Component === 'string') {
          passedProps = {
            className: props.className,
            style: props.style,
            ...props.componentProps,
          };
        }
        return <Component {...passedProps}>{children}</Component>;
      }
      return children[0] || null;
    }

AnimateChild

AnimateChild組件并沒有react原生的生命周期函數(shù)包括constructor蛇数,render函數(shù)也只是簡單的返回了this.props.children。由此可見是越,AnimateChild其實是一個類耳舅,提供一些接口。下面倚评,主要了解一下他的接口都是做什么的浦徊。

先從我們上邊講的performAppear函數(shù)調(diào)用的componentWillAppear函數(shù)開始講

componentWillAppear

AnimateChild組件的componentWillAppear,componentWillEnter天梧,componentWillLeave全都一樣盔性,判斷一下是否做動畫,做就調(diào)用transition方法呢岗,不然就調(diào)用done冕香。
然后說transition,這是AnimateChild的核心方法

    componentWillAppear(done) {
      if (animUtil.isAppearSupported(this.props)) {
        this.transition('appear', done);
      } else {
        done();
      }
    }

transition

    transition(animationType, finishCallback) {
      const node = ReactDOM.findDOMNode(this);
      const props = this.props;
      const transitionName = props.transitionName;
      const nameIsObj = typeof transitionName === 'object';
      this.stop();
      const end = () => {
        this.stopper = null;
        finishCallback();
      };
      // props.animation是如果使用第三方動畫類庫需要傳入的對象后豫,props[transitionMap[animationType]]是一個布爾值悉尾,對應(yīng)著transitionAppear等三個api
    // 這個判斷翻譯過來就是,支持css動畫或者不使用css類庫并且有自己的css類名并且的確要做這一步的動畫
      if ((isCssAnimationSupported || !props.animation[animationType]) &&
        transitionName && props[transitionMap[animationType]]) {
        // 這一大串挫酿,都是在拼接字符串构眯,拼接出要添加的類名
        const name = nameIsObj ? transitionName[animationType] : `${transitionName}-${animationType}`;
        let activeName = `${name}-active`;
        if (nameIsObj && transitionName[`${animationType}Active`]) {
          activeName = transitionName[`${animationType}Active`];
        }
        // 核心中的核心,調(diào)用cssAnimate方法并傳入回調(diào)
        this.stopper = cssAnimate(node, {
          name,
          active: activeName,
        }, end);
      } else {
        this.stopper = props.animation[animationType](node, end);
      }
    }

cssAnimate

cssAnimate庫包含兩個js文件饭豹,一個index.js是提供給我們使用的鸵赖,用來觸發(fā)動畫或者過渡务漩。另一個event.js是支撐index.js的運(yùn)行的,event.js在內(nèi)部封裝了函數(shù)它褪,用來檢測瀏覽器是否執(zhí)行完了css動畫饵骨。(這是一個新的知識點,之前從未了解過茫打。上邊講的cssAnimate方法是index.js提供的居触。下面我們先說他。

index

index.js里的工具方法與細(xì)枝末節(jié)就不說了老赤,直接說cssAnimate這個函數(shù)

    const cssAnimation = (node, transitionName, endCallback) => {
      // 先是一大串字符串拼接轮洋,得出要添加的class類名
      const nameIsObj = typeof transitionName === 'object';
      const className = nameIsObj ? transitionName.name : transitionName;
      const activeClassName = nameIsObj ? transitionName.active : `${transitionName}-active`;
      let end = endCallback;
      let start;
      let active;
      // 這個classes是引用的component-classes這個庫的api,用來跨瀏覽器操作dom元素的類名抬旺,理解為jq吧弊予,但是只有類名的增刪改查
      const nodeClasses = classes(node);
      // 如果是對象,就解構(gòu)一下开财,拿到真正的回調(diào)函數(shù)
      if (endCallback && Object.prototype.toString.call(endCallback) === '[object Object]') {
        end = endCallback.end;
        start = endCallback.start;
        active = endCallback.active;
      }
      // 這是cssAnimate自己定義的一個方法汉柒,動畫結(jié)束時的回調(diào)
      if (node.rcEndListener) {
        node.rcEndListener();
      }

      node.rcEndListener = (e) => {
        if (e && e.target !== node) {
          return;
        }
  
        if (node.rcAnimTimeout) {
          clearTimeout(node.rcAnimTimeout);
          node.rcAnimTimeout = null;
        }

        clearBrowserBugTimeout(node);

        nodeClasses.remove(className);
        nodeClasses.remove(activeClassName);

        Event.removeEndEventListener(node, node.rcEndListener);
        node.rcEndListener = null;

        // Usually this optional end is used for informing an owner of
        // a leave animation and telling it to remove the child.
        if (end) {
          end();
        }
      };
      // 綁定動畫結(jié)束的監(jiān)聽事件
      Event.addEndEventListener(node, node.rcEndListener);
      // 真正開始了
      if (start) {
        start();
      }
      nodeClasses.add(className);
      // 這里延時加載了實現(xiàn)動畫效果的activeClassName,還有生命周期函數(shù)active
      node.rcAnimTimeout = setTimeout(() => {
        node.rcAnimTimeout = null;
        nodeClasses.add(activeClassName);
        if (active) {
          setTimeout(active, 0);
        }
        fixBrowserByTimeout(node);
        // 30ms for firefox
      }, 30);
      // node.rcEndListener在自己被調(diào)用之后會將自己置為空责鳍,我認(rèn)為這里的返回是為了提供一個手動停止動畫的方法
      return {
        stop() {
          if (node.rcEndListener) {
            node.rcEndListener();
          }
        },
      };
    };

這里就結(jié)束了碾褂,梳理之后對于react實現(xiàn)動畫就有了理解了,用起來不會那么迷糊历葛。其實感覺實現(xiàn)的代碼不是特別難正塌,主要是邏輯分層非常清晰。學(xué)習(xí)到了一個好的代碼應(yīng)該是什么樣的恤溶。解耦功能乓诽,起好變量名,完善而清晰的邏輯宏娄,這些是學(xué)到的最重要的東西

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末问裕,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子孵坚,更是在濱河造成了極大的恐慌粮宛,老刑警劉巖,帶你破解...
    沈念sama閱讀 222,252評論 6 516
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件卖宠,死亡現(xiàn)場離奇詭異巍杈,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)扛伍,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,886評論 3 399
  • 文/潘曉璐 我一進(jìn)店門筷畦,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事鳖宾『鹕埃” “怎么了?”我有些...
    開封第一講書人閱讀 168,814評論 0 361
  • 文/不壞的土叔 我叫張陵鼎文,是天一觀的道長渔肩。 經(jīng)常有香客問我,道長拇惋,這世上最難降的妖魔是什么周偎? 我笑而不...
    開封第一講書人閱讀 59,869評論 1 299
  • 正文 為了忘掉前任,我火速辦了婚禮撑帖,結(jié)果婚禮上蓉坎,老公的妹妹穿的比我還像新娘。我一直安慰自己胡嘿,他們只是感情好蛉艾,可當(dāng)我...
    茶點故事閱讀 68,888評論 6 398
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著灶平,像睡著了一般伺通。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上逢享,一...
    開封第一講書人閱讀 52,475評論 1 312
  • 那天,我揣著相機(jī)與錄音吴藻,去河邊找鬼瞒爬。 笑死,一個胖子當(dāng)著我的面吹牛沟堡,可吹牛的內(nèi)容都是我干的侧但。 我是一名探鬼主播,決...
    沈念sama閱讀 41,010評論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼航罗,長吁一口氣:“原來是場噩夢啊……” “哼禀横!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起粥血,我...
    開封第一講書人閱讀 39,924評論 0 277
  • 序言:老撾萬榮一對情侶失蹤柏锄,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后复亏,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體趾娃,經(jīng)...
    沈念sama閱讀 46,469評論 1 319
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,552評論 3 342
  • 正文 我和宋清朗相戀三年缔御,在試婚紗的時候發(fā)現(xiàn)自己被綠了抬闷。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,680評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡耕突,死狀恐怖笤成,靈堂內(nèi)的尸體忽然破棺而出评架,到底是詐尸還是另有隱情,我是刑警寧澤炕泳,帶...
    沈念sama閱讀 36,362評論 5 351
  • 正文 年R本政府宣布纵诞,位于F島的核電站,受9級特大地震影響喊崖,放射性物質(zhì)發(fā)生泄漏挣磨。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 42,037評論 3 335
  • 文/蒙蒙 一荤懂、第九天 我趴在偏房一處隱蔽的房頂上張望茁裙。 院中可真熱鬧,春花似錦节仿、人聲如沸晤锥。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,519評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽矾瘾。三九已至,卻和暖如春箭启,著一層夾襖步出監(jiān)牢的瞬間壕翩,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,621評論 1 274
  • 我被黑心中介騙來泰國打工傅寡, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留放妈,地道東北人。 一個月前我還...
    沈念sama閱讀 49,099評論 3 378
  • 正文 我出身青樓荐操,卻偏偏與公主長得像芜抒,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子托启,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,691評論 2 361

推薦閱讀更多精彩內(nèi)容