react動畫開源庫代碼學習之rc-animate

rc-animate

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

對單個元素根據狀態進行動畫顯示隱藏,需結合 css 或其它第三方動畫類一起使用

代碼結構

code.PNG

rc-animate的源代碼src文件夾下只有Animate,AnimateChild,ChildrenUtils,Utils這四個js文件,后兩個utils是工具類js,用來檢測組件的props是否含有某個值這樣的工作等,不過多介紹。
Animate.js是我們庫暴露給我們使用的組件,他會在內部做一些檢測,回調等等操作。然后調用AnimateChild組件,AnimateChild是實際實現動畫的地方。AnimateChild中使用了css-animate這個庫,css-animate才是最核心的操作,他將給dom元素添加指定的css類名。另一個animateUtils是上一層的utils.js這個文件,我寫錯了,這里說明一下。
先從rc-animate的最外層,我們最先接觸到的Animate.js講起。

Animate.js

簡書上寫大段的代碼太費勁了,我就一小段一小段的解釋吧。

constructor

這個沒什么難點,就是普通的初始化。currentlyAnimatingKeys和childrenRefs在后續會比較重要,使用次數比較多

constructor(props) {
  super(props);
  // 這個數組用來儲存正在進行動畫的dom節點的key值
  this.currentlyAnimatingKeys = {};
  // 這兩個數組就顧名思義啦
  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,原文解釋為:'子級動畫的類型,顯示或隱藏'
  // 完全不理解他的意思,剛好官網的代碼示例也沒有用帶這個參數,我們就暫且跳過他,給他一個null值吧
  if (showProp) {
    children = children.filter((child) => {
      return !!child.props[showProp];
    });
  }
  // 遍歷子節點,并調用performAppear方法,這個方法名翻譯一下就是:‘執行顯示’,所以這就是我們的css效果的第一個觸發點
  // 完成組件掛載后,讓組件執行css動畫,也就是常見的淡入效果之類的。
  children.forEach((child) => {
    if (child) {
      this.performAppear(child.key);
    }
  });
}

performAppear

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

performAppear = (key) => {
  if (this.childrenRefs[key]) {
    // 用key值找到目標組件,然后對currentlyAnimatingKeys數組做一個標識,告訴大家,這個組件正在進行動畫
    this.currentlyAnimatingKeys[key] = true;
    // 調用實例上的方法,這個componentWillAppear方法,是Ref對應的實例自己提供的一個實例方法(這里實例對應的Class是AnimateChild)
   // 可以將componentWillAppear理解為AnimateChild的一個生命周期函數,Animate就是執行這個生命周期函數的框架
  // 傳遞給可以將componentWillAppear的方法是一個回調函數
    this.childrenRefs[key].componentWillAppear(
      this.handleDoneAdding.bind(this, key, 'appear')
    );
  }
}

我想按照調用組件時代碼的執行順序來梳理整個庫的代碼,所以接下來不一一說明Animate類里的方法了,而是講他的render函數與AnimateChild.js的內容

render

    render() {
      const props = this.props;
      this.nextProps = props;
      const stateChildren = this.state.children;
      let children = null;
      // 先map拿到被AnimateChild包裝好的組件數組
      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數組里儲存的就是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,用來指定需要替換的標簽
      // 這里可以看到,如果沒有component的話,會只渲染組件數組的第一項
      // 有component則會全部渲染,因該是為了保證有一個父級節點去包裹,以便進行動畫
      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原生的生命周期函數包括constructor,render函數也只是簡單的返回了this.props.children。由此可見,AnimateChild其實是一個類,提供一些接口。下面,主要了解一下他的接口都是做什么的。

先從我們上邊講的performAppear函數調用的componentWillAppear函數開始講

componentWillAppear

AnimateChild組件的componentWillAppear,componentWillEnter,componentWillLeave全都一樣,判斷一下是否做動畫,做就調用transition方法,不然就調用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]]是一個布爾值,對應著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`];
        }
        // 核心中的核心,調用cssAnimate方法并傳入回調
        this.stopper = cssAnimate(node, {
          name,
          active: activeName,
        }, end);
      } else {
        this.stopper = props.animation[animationType](node, end);
      }
    }

cssAnimate

cssAnimate庫包含兩個js文件,一個index.js是提供給我們使用的,用來觸發動畫或者過渡。另一個event.js是支撐index.js的運行的,event.js在內部封裝了函數,用來檢測瀏覽器是否執行完了css動畫。(這是一個新的知識點,之前從未了解過。上邊講的cssAnimate方法是index.js提供的。下面我們先說他。

index

index.js里的工具方法與細枝末節就不說了,直接說cssAnimate這個函數

    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);
      // 如果是對象,就解構一下,拿到真正的回調函數
      if (endCallback && Object.prototype.toString.call(endCallback) === '[object Object]') {
        end = endCallback.end;
        start = endCallback.start;
        active = endCallback.active;
      }
      // 這是cssAnimate自己定義的一個方法,動畫結束時的回調
      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();
        }
      };
      // 綁定動畫結束的監聽事件
      Event.addEndEventListener(node, node.rcEndListener);
      // 真正開始了
      if (start) {
        start();
      }
      nodeClasses.add(className);
      // 這里延時加載了實現動畫效果的activeClassName,還有生命周期函數active
      node.rcAnimTimeout = setTimeout(() => {
        node.rcAnimTimeout = null;
        nodeClasses.add(activeClassName);
        if (active) {
          setTimeout(active, 0);
        }
        fixBrowserByTimeout(node);
        // 30ms for firefox
      }, 30);
      // node.rcEndListener在自己被調用之后會將自己置為空,我認為這里的返回是為了提供一個手動停止動畫的方法
      return {
        stop() {
          if (node.rcEndListener) {
            node.rcEndListener();
          }
        },
      };
    };

這里就結束了,梳理之后對于react實現動畫就有了理解了,用起來不會那么迷糊。其實感覺實現的代碼不是特別難,主要是邏輯分層非常清晰。學習到了一個好的代碼應該是什么樣的。解耦功能,起好變量名,完善而清晰的邏輯,這些是學到的最重要的東西

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

推薦閱讀更多精彩內容