如何优雅的展示动态图标lottie-react-native

末蓝、 2023-07-21 11:09 67阅读 0赞

### 如何优雅的展示动态图标lottie-react-native ###

项目中，需要使用到动态图标，发现又好用的库，在这里分享一下，需要使用的工具库为[lottie-react-native][]，通过导出`AE`软件中的动画特效，以json文件的方式导出，来实现动画的效果。

#### 一、Lottie是什么？ ####

Lottie是Airbnb开源的一个支持 Android、iOS 以及 ReactNative，利用Json文件的方式快速实现动画效果的库。简单点说就是Json文件记录动画路径，Android、iOS 以及 ReactNative解析展现出来。

#### 二、Lottie能实现什么效果？ ####

![效果][20200403203648139.gif_pic_center]  
![20200403203723872.gif_pic_center][]  
![20200403203741494.gif_pic_center][]  
![20200403203813212.gif_pic_center][]  
![20200403203907362.gif_pic_center][]

#### 三、集成过程 ####

##### 1.安装拉取第三方包： #####

yarn add lottie-react-native
    yarn add lottie-ios@3.1.3

npm i --save lottie-react-native
    npm i --save lottie-ios@3.1.3

如果是ios平台，请继续执行下面命令（react-native 版本大于0.60或更高的不需要手动react-native link,而是通过pod install安装依赖）：

cd ios && pod install

至此，就完成了第三方包的引入工作。  
⚠️：Android平台不需要特殊处理，除非报错崩溃了，请检查以下位置：  
a.路径`android/app/src/main/java/<AppName>/MainApplication.java`

在顶部导入,添加

import com.airbnb.android.react.lottie.LottiePackage;

在 List getPackages();中,添加

packages.add(new LottiePackage());

b.路径`android/app/build.gradle`,dependencies依赖块添加

implementation project(':lottie-react-native')

c.路径`android/settings.gradle`添加

include ':lottie-react-native'
    project(':lottie-react-native').projectDir = new File(rootProject.projectDir, '../node_modules/lottie-react-native/src/android')

##### 2.获取json文件 #####

这个使用的json文件，是由[Adobe After Effects][]这个软件生成，然后通过其插件[bodymovin ][bodymovin] 生成，同时这里有[安装教程][Link 1],具体导出过程烦请请教UI设计，他们可能会更熟悉。如果实在找不到了，就使用这里的json文件->[文件地址][Link 2]

##### 3.组件库的使用 #####

假设我们已经获取到这个animation.json文件了，如下所示最基础的使用方法：

import React from 'react';
    import LottieView from 'lottie-react-native';
    
    export default class BasicExample extends React.Component {
      render() {
        return <LottieView source={require('./animation.json')} autoPlay loop />;
      }
    }

当然，还有其他接口提供使用

import React from 'react';
    import LottieView from 'lottie-react-native';
    
    export default class BasicExample extends React.Component {
      componentDidMount() {
        // 手动控制播放
        this.animation.play();
        // 设置特定的开始时间和结束时间
        this.animation.play(30, 120);
      }
    
      render() {
        return (
          <LottieView
            ref={animation => {
              this.animation = animation;
            }}
            source={require('../path/to/animation.json')}
          />
        );
      }
    }

结合react-native组件Animated实现控制动画播放的过程

import React from 'react';
    import { Animated, Easing } from 'react-native';
    import LottieView from 'lottie-react-native';
    
    export default class BasicExample extends React.Component {
      constructor(props) {
        super(props);
        this.state = {
          progress: new Animated.Value(0),
        };
      }
    
      componentDidMount() {
        Animated.timing(this.state.progress, {
          toValue: 1,
          duration: 5000,
          easing: Easing.linear,
        }).start();
      }
    
      render() {
        return (
          <LottieView source={require('../path/to/animation.json')} progress={this.state.progress} />
        );
      }
    }

还能够指定的更改图层的颜色

import React from 'react';
    import LottieView from 'lottie-react-native';
    
    export default class BasicExample extends React.Component {
      render() {
        return (
          <LottieView
            source={require('../path/to/animation.json')}
            colorFilters={[{
              keypath: "button",
              color: "#F00000"
            },{
              keypath: "Sending Loader",
              color: "#F00000"
            }]}
            autoPlay
            loop
          />
        );
      }
    }

###### Component API: ######

<table> 
 <thead> 
  <tr> 
   <th>Prop</th> 
   <th>Description</th> 
   <th>Default</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><strong><code>source</code></strong></td> 
   <td><strong>Mandatory</strong> - The source of animation. Can be referenced as a local asset by a string, or remotely with an object with a <code>uri</code> property, or it can be an actual JS object of an animation, obtained (for example) with something like <code>require('../path/to/animation.json')</code></td> 
   <td><em>None</em></td> 
  </tr> 
  <tr> 
   <td><strong><code>progress</code></strong></td> 
   <td>A number between 0 and 1, or an <code>Animated</code> number between 0 and 1. This number represents the normalized progress of the animation. If you update this prop, the animation will correspondingly update to the frame at that progress value. This prop is not required if you are using the imperative API.</td> 
   <td><code>0</code></td> 
  </tr> 
  <tr> 
   <td><strong><code>speed</code></strong></td> 
   <td>The speed the animation will progress. Sending a negative value will reverse the animation</td> 
   <td><code>1</code></td> 
  </tr> 
  <tr> 
   <td><strong><code>duration</code></strong></td> 
   <td>The duration of the animation in ms. Takes precedence over <code>speed</code> when set. This only works when <code>source</code> is an actual JS object of an animation.</td> 
   <td><code>undefined</code></td> 
  </tr> 
  <tr> 
   <td><strong><code>loop</code></strong></td> 
   <td>A boolean flag indicating whether or not the animation should loop.</td> 
   <td><code>true</code></td> 
  </tr> 
  <tr> 
   <td><strong><code>autoPlay</code></strong></td> 
   <td>A boolean flag indicating whether or not the animation should start automatically when mounted. This only affects the imperative API.</td> 
   <td><code>false</code></td> 
  </tr> 
  <tr> 
   <td><strong><code>autoSize</code></strong></td> 
   <td>A boolean flag indicating whether or not the animation should size itself automatically according to the width in the animation’s JSON. This only works when <code>source</code> is an actual JS object of an animation.</td> 
   <td><code>false</code></td> 
  </tr> 
  <tr> 
   <td><strong><code>style</code></strong></td> 
   <td>Style attributes for the view, as expected in a standard <a href="http://facebook.github.io/react-native/releases/0.46/docs/layout-props.html" rel="nofollow"><code>View</code></a>, aside from border styling</td> 
   <td><em>None</em></td> 
  </tr> 
  <tr> 
   <td><strong><code>imageAssetsFolder</code></strong></td> 
   <td>Needed for <strong>Android</strong> to work properly with assets, iOS will ignore it.</td> 
   <td><em>None</em></td> 
  </tr> 
  <tr> 
   <td><strong><code>onAnimationFinish</code></strong></td> 
   <td>A callback function which will be called when animation is finished. Note that this callback will be called only when <code>loop</code> is set to false.</td> 
   <td><em>None</em></td> 
  </tr> 
 </tbody> 
</table>

###### Methods (Imperative API): ######

<table> 
 <thead> 
  <tr> 
   <th>Method</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><strong><code>play</code></strong></td> 
   <td>Play the animation all the way through, at the speed specified as a prop. It can also play a section of the animation when called as <code>play(startFrame, endFrame)</code>.</td> 
  </tr> 
  <tr> 
   <td><strong><code>reset</code></strong></td> 
   <td>Reset the animation back to <code>0</code> progress.</td> 
  </tr> 
 </tbody> 
</table>

更多的接口可以参见：[接口参见][Link 3]

#### 四、集成效果图 ####

![在这里插入图片描述][20200403233950135.gif_pic_center]  
![在这里插入图片描述][20200404112245199.gif_pic_center]  
![在这里插入图片描述][2020011617044891.gif_pic_center]

#### 五、可能遇到的问题 ####

##### 1.Undefined symbol: protocol xxx #####

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1d3UxNTA_size_16_color_FFFFFF_t_70_pic_center]  
解决方案：  
1.在Xcode中打开ios / YourAppName.xcodeproj  
2.在左侧的项目浏览器中，右键单击您的应用程序名称，然后单击新建文件…。 为项目创建一个空的Swift文件（添加时请确保选择了target是“您的应用名称”）  
3.当Xcode询问时，按Create Bridging Header，然后不要删除Swift文件。重新运行您的构建。  
参考地址：  
1.[https://github.com/mxcl/PromiseKit/issues/1059][https_github.com_mxcl_PromiseKit_issues_1059]  
2.[https://stackoverflow.com/questions/57903395/about-100-error-in-xcode-undefined-symbols-for-architecture-x86-64-upgraded-re][https_stackoverflow.com_questions_57903395_about-100-error-in-xcode-undefined-symbols-for-architecture-x86-64-upgraded-re]  
3.[Android开发之Lottie动画解析库][Android_Lottie]

--------------------

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1d3UxNTA_size_16_color_FFFFFF_t_70_pic_center 1]

[lottie-react-native]: https://www.npmjs.com/package/lottie-react-native
[20200403203648139.gif_pic_center]: /images/20230528/4de4e462dc494451b18aedc55d660d25.png
[20200403203723872.gif_pic_center]: /images/20230528/9474232fdd484816ac1ecab2dac09577.png
[20200403203741494.gif_pic_center]: /images/20230528/050683b4e8c343e89be0f6ce197adcf8.png
[20200403203813212.gif_pic_center]: /images/20230528/6258df1edfbb4cacb908b3fc0b4ba2de.png
[20200403203907362.gif_pic_center]: /images/20230528/3e9799cff6f6471aa93e4bcfffc491f0.png
[Adobe After Effects]: https://www.adobe.com/products/aftereffects.html
[bodymovin]: http://aescripts.com/bodymovin/
[Link 1]: https://github.com/airbnb/lottie-web
[Link 2]: https://github.com/react-native-community/lottie-react-native/tree/master/example/js/animations
[Link 3]: https://github.com/react-native-community/lottie-react-native/blob/master/docs/api.md
[20200403233950135.gif_pic_center]: /images/20230528/ff8f6fb4f7d94f9082ad779c64b15dca.png
[20200404112245199.gif_pic_center]: /images/20230528/4b63ba0c91744475ad48df525cbf49d5.png
[2020011617044891.gif_pic_center]: /images/20230528/c7ca0c6f5ca0400b87d7f3c63617ae90.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1d3UxNTA_size_16_color_FFFFFF_t_70_pic_center]: /images/20230528/3ebdb635811445d493ee8b4278cf12c0.png
[https_github.com_mxcl_PromiseKit_issues_1059]: https://github.com/mxcl/PromiseKit/issues/1059
[https_stackoverflow.com_questions_57903395_about-100-error-in-xcode-undefined-symbols-for-architecture-x86-64-upgraded-re]: https://stackoverflow.com/questions/57903395/about-100-error-in-xcode-undefined-symbols-for-architecture-x86-64-upgraded-re
[Android_Lottie]: https://www.pianshen.com/article/3040237699/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1d3UxNTA_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20230528/20cc9e8199034ab189c001f79b184921.png