欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

编写React组件项目实践分析

程序员文章站 2022-08-31 19:15:55
当我刚开始写react的时候,我看过很多写组件的方法。一百篇教程就有一百种写法。虽然react本身已经成熟了,但是如何使用它似乎还没有一个“正确”的方法。所以我(作者)把我...

当我刚开始写react的时候,我看过很多写组件的方法。一百篇教程就有一百种写法。虽然react本身已经成熟了,但是如何使用它似乎还没有一个“正确”的方法。所以我(作者)把我们团队这些年来总结的使用react的经验总结在这里。希望这篇文字对你有用,不管你是初学者还是老手。

开始前:

我们使用es6、es7语法如果你不是很清楚展示组件和容器组件的区别,建议您从阅读这篇文章开始如果您有任何的建议、疑问都清在评论里留言 基于类的组件

现在开发react组件一般都用的是基于类的组件。下面我们就来一行一样的编写我们的组件:

import react, { component } from 'react';
import { observer } from 'mobx-react';

import expandableform from './expandableform';
import './styles/profilecontainer.css';

我很喜欢css in javascript。但是,这个写样式的方法还是太新了。所以我们在每个组件里引入css文件。而且本地引入的import和全局的import会用一个空行来分割。

初始化state

import react, { component } from 'react'
import { observer } from 'mobx-react'

import expandableform from './expandableform'
import './styles/profilecontainer.css'

export default class profilecontainer extends component {
 state = { expanded: false }
您可以使用了老方法在constructor里初始化state。更多相关可以看这里。但是我们选择更加清晰的方法。
同时,我们确保在类前面加上了export default。(译者注:虽然这个在使用了redux的时候不一定对)。

proptypes and defaultprops

import react, { component } from 'react'
import { observer } from 'mobx-react'
import { string, object } from 'prop-types'

import expandableform from './expandableform'
import './styles/profilecontainer.css'

export default class profilecontainer extends component {
 state = { expanded: false }
 
 static proptypes = {
  model: object.isrequired,
  title: string
 }
 
 static defaultprops = {
  model: {
   id: 0
  },
  title: 'your name'
 }

 // ...
}

proptypesdefaultprops是静态属性。尽可能在组件类的的前面定义,让其他的开发人员读代码的时候可以立刻注意到。他们可以起到文档的作用。

如果你使用了react 15.3.0或者更高的版本,那么需要另外引入prop-types包,而不是使用react.proptypes。更多内容移步这里。

你所有的组件都应该有prop types。

方法

import react, { component } from 'react'
import { observer } from 'mobx-react'
import { string, object } from 'prop-types'

import expandableform from './expandableform'
import './styles/profilecontainer.css'

export default class profilecontainer extends component {
 state = { expanded: false }
 
 static proptypes = {
  model: object.isrequired,
  title: string
 }
 
 static defaultprops = {
  model: {
   id: 0
  },
  title: 'your name'
 }
 handlesubmit = (e) => {
  e.preventdefault()
  this.props.model.save()
 }
 
 handlenamechange = (e) => {
  this.props.model.changename(e.target.value)
 }
 
 handleexpand = (e) => {
  e.preventdefault()
  this.setstate({ expanded: !this.state.expanded })
 }

 // ...

}

在类组件里,当你把方法传递给子组件的时候,需要确保他们被调用的时候使用的是正确的this。一般都会在传给子组件的时候这么做:this.handlesubmit.bind(this)

使用es6的箭头方法就简单多了。它会自动维护正确的上下文(this)。

给setstate传入一个方法

在上面的例子里有这么一行:

this.setstate({ expanded: !this.state.expanded });
setstate其实是异步的!react为了提高性能,会把多次调用的setstate放在一起调用。所以,调用了setstate之后state不一定会立刻就发生改变。

所以,调用setstate的时候,你不能依赖于当前的state值。因为i根本不知道它是值会是神马。

解决方法:给setstate传入一个方法,把调用前的state值作为参数传入这个方法。看看例子:

this.setstate(prevstate => ({ expanded: !prevstate.expanded }))
感谢austin wood的帮助。

拆解组件

import react, { component } from 'react'
import { observer } from 'mobx-react'

import { string, object } from 'prop-types'
import expandableform from './expandableform'
import './styles/profilecontainer.css'

export default class profilecontainer extends component {
 state = { expanded: false }
 
 static proptypes = {
  model: object.isrequired,
  title: string
 }
 
 static defaultprops = {
  model: {
   id: 0
  },
  title: 'your name'
 }

 handlesubmit = (e) => {
  e.preventdefault()
  this.props.model.save()
 }
 
 handlenamechange = (e) => {
  this.props.model.changename(e.target.value)
 }
 
 handleexpand = (e) => {
  e.preventdefault()
  this.setstate(prevstate => ({ expanded: !prevstate.expanded }))
 }
 
 render() {
  const {
   model,
   title
  } = this.props
  return ( 
   <expandableform 
    onsubmit={this.handlesubmit} 
    expanded={this.state.expanded} 
    onexpand={this.handleexpand}>
    <div>
     <h1>{title}</h1>
     <input
      type="text"
      value={model.name}
      onchange={this.handlenamechange}
      placeholder="your name"/>
    </div>
   </expandableform>
  )
 }
}

有多行的props的,每一个prop都应该单独占一行。就如上例一样。要达到这个目标最好的方法是使用一套工具:prettier

装饰器(decorator)

@observer
export default class profilecontainer extends component {

如果你了解某些库,比如mobx,你就可以使用上例的方式来修饰类组件。装饰器就是把类组件作为一个参数传入了一个方法。

装饰器可以编写更灵活、更有可读性的组件。如果你不想用装饰器,你可以这样:

class profilecontainer extends component {
 // component code
}
export default observer(profilecontainer)

闭包

尽量避免在子组件中传入闭包,如:

<input
 type="text"
 value={model.name}
 // onchange={(e) => { model.name = e.target.value }}
 // ^ not this. use the below:
 onchange={this.handlechange}
 placeholder="your name"/>
注意:如果input是一个react组件的话,这样自动触发它的重绘,不管其他的props是否发生了改变。

一致性检验是react最消耗资源的部分。不要把额外的工作加到这里。处理上例中的问题最好的方法是传入一个类方法,这样还会更加易读,更容易调试。如:

import react, { component } from 'react'
import { observer } from 'mobx-react'
import { string, object } from 'prop-types'
// separate local imports from dependencies
import expandableform from './expandableform'
import './styles/profilecontainer.css'

// use decorators if needed
@observer
export default class profilecontainer extends component {
 state = { expanded: false }
 // initialize state here (es7) or in a constructor method (es6)
 
 // declare proptypes as static properties as early as possible
 static proptypes = {
  model: object.isrequired,
  title: string
 }

 // default props below proptypes
 static defaultprops = {
  model: {
   id: 0
  },
  title: 'your name'
 }

 // use fat arrow functions for methods to preserve context (this will thus be the component instance)
 handlesubmit = (e) => {
  e.preventdefault()
  this.props.model.save()
 }
 
 handlenamechange = (e) => {
  this.props.model.name = e.target.value
 }
 
 handleexpand = (e) => {
  e.preventdefault()
  this.setstate(prevstate => ({ expanded: !prevstate.expanded }))
 }
 
 render() {
  // destructure props for readability
  const {
   model,
   title
  } = this.props
  return ( 
   <expandableform 
    onsubmit={this.handlesubmit} 
    expanded={this.state.expanded} 
    onexpand={this.handleexpand}>
    // newline props if there are more than two
    <div>
     <h1>{title}</h1>
     <input
      type="text"
      value={model.name}
      // onchange={(e) => { model.name = e.target.value }}
      // avoid creating new closures in the render method- use methods like below
      onchange={this.handlenamechange}
      placeholder="your name"/>
    </div>
   </expandableform>
  )
 }
}

方法组件

这类组件没有state没有props,也没有方法。它们是纯组件,包含了最少的引起变化的内容。经常使用它们。

proptypes

import react from 'react'
import { observer } from 'mobx-react'
import { func, bool } from 'prop-types'
import './styles/form.css'
expandableform.proptypes = {
 onsubmit: func.isrequired,
 expanded: bool
}
// component declaration

我们在组件的声明之前就定义了proptypes

分解props和defaultprops

import react from 'react'
import { observer } from 'mobx-react'
import { func, bool } from 'prop-types'
import './styles/form.css'

expandableform.proptypes = {
 onsubmit: func.isrequired,
 expanded: bool,
 onexpand: func.isrequired
}

function expandableform(props) {
 const formstyle = props.expanded ? {height: 'auto'} : {height: 0}
 return (
  <form style={formstyle} onsubmit={props.onsubmit}>
   {props.children}
   <button onclick={props.onexpand}>expand</button>
  </form>
 )
}

我们的组件是一个方法。它的参数就是props。我们可以这样扩展这个组件:

import react from 'react'
import { observer } from 'mobx-react'
import { func, bool } from 'prop-types'
import './styles/form.css'

expandableform.proptypes = {
 onsubmit: func.isrequired,
 expanded: bool,
 onexpand: func.isrequired
}

function expandableform({ onexpand, expanded = false, children, onsubmit }) {
 const formstyle = expanded ? {height: 'auto'} : {height: 0}
 return (
  <form style={formstyle} onsubmit={onsubmit}>
   {children}
   <button onclick={onexpand}>expand</button>
  </form>
 )
}

现在我们也可以使用默认参数来扮演默认props的角色,这样有很好的可读性。如果expanded没有定义,那么我们就把它设置为false

但是,尽量避免使用如下的例子:

const expandableform = ({ onexpand, expanded, children }) => {

看起来很现代,但是这个方法是未命名的。

如果你的babel配置正确,未命名的方法并不会是什么大问题。但是,如果babel有问题的话,那么这个组件里的任何错误都显示为发生在 <>里的,这调试起来就非常麻烦了。

匿名方法也会引起jest其他的问题。由于会引起各种难以理解的问题,而且也没有什么实际的好处。我们推荐使用function,少使用const

装饰方法组件

由于方法组件没法使用装饰器,只能把它作为参数传入别的方法里。

import react from 'react'
import { observer } from 'mobx-react'
import { func, bool } from 'prop-types'
import './styles/form.css'

expandableform.proptypes = {
 onsubmit: func.isrequired,
 expanded: bool,
 onexpand: func.isrequired
}

function expandableform({ onexpand, expanded = false, children, onsubmit }) {
 const formstyle = expanded ? {height: 'auto'} : {height: 0}
 return (
  <form style={formstyle} onsubmit={onsubmit}>
   {children}
   <button onclick={onexpand}>expand</button>
  </form>
 )
}
export default observer(expandableform)

只能这样处理:export default observer(expandableform)

这就是组件的全部代码:

import react from 'react'
import { observer } from 'mobx-react'
import { func, bool } from 'prop-types'
// separate local imports from dependencies
import './styles/form.css'

// declare proptypes here, before the component (taking advantage of js function hoisting)
// you want these to be as visible as possible
expandableform.proptypes = {
 onsubmit: func.isrequired,
 expanded: bool,
 onexpand: func.isrequired
}

// destructure props like so, and use default arguments as a way of setting defaultprops
function expandableform({ onexpand, expanded = false, children, onsubmit }) {
 const formstyle = expanded ? { height: 'auto' } : { height: 0 }
 return (
  <form style={formstyle} onsubmit={onsubmit}>
   {children}
   <button onclick={onexpand}>expand</button>
  </form>
 )
}

// wrap the component instead of decorating it
export default observer(expandableform)

条件判断

某些情况下,你会做很多的条件判断:

<div id="lb-footer">
 {props.downloadmode && currentimage && !currentimage.video && currentimage.blogtext
 ? !currentimage.submitted && !currentimage.posted
 ? <p>please contact us for content usage</p>
  : currentimage && currentimage.selected
   ? <button onclick={props.onselectimage} classname="btn btn-selected">deselect</button>
   : currentimage && currentimage.submitted
    ? <button classname="btn btn-submitted" disabled>submitted</button>
    : currentimage && currentimage.posted
     ? <button classname="btn btn-posted" disabled>posted</button>
     : <button onclick={props.onselectimage} classname="btn btn-unselected">select post</button>
 }
</div>

这么多层的条件判断可不是什么好现象。

有第三方库jsx-control statements可以解决这个问题。但是与其增加一个依赖,还不如这样来解决:

<div id="lb-footer">
 {
  (() => {
   if(downloadmode && !videosrc) {
    if(isapproved && isposted) {
     return <p>right click image and select "save image as.." to download</p>
    } else {
     return <p>please contact us for content usage</p>
    }
   }

   // ...
  })()
 }
</div>

使用大括号包起来的iife,然后把你的if表达式都放进去。返回你要返回的组件。

最后

再次,希望本文对你有用。如果你有什么好的意见或者建议的话请写在下面的评论里。谢谢!