前端开发代码规范 React 编码规约

基本

1.1

每个文件只写一个组件，但是多个无状态组件可以放在单个文件中。

组件

2.1

【强制】有内部状态，方法或者是要对外暴露ref的组件，使用ES6 Class写法。

// bad
const Listing = React.createClass({
  // ...
  render() {
    return 
{this.state.hello}
;
  }
});

// good
class Listing extends React.Component {
  // ...
  render() {
    return 
{this.state.hello}
;
  }
}

2.2

没有内部状态，方法或者是无需对外暴露ref的组件，使用函数写法。

// bad
class Listing extends React.Component {
  render() {
    return 
{this.props.hello}
;
  }
}

// good
const Listing = ({ hello }) => (
  
{hello}
);

PropTypes/DefaultProps

3.1

有内部状态，方法或者是要对外暴露ref的组件，使用ES7类静态属性提案写法。

class Button extends Component {
  static propTypes = {
    size: React.PropTypes.oneOf(['large', 'normal', 'small']),
    shape: React.PropTypes.oneOf(['default', 'primary', 'ghost'])
    disabled: React.PropTypes.bool
  };

  static defaultProps = {
    size: 'normal',
    shape: 'default',
    disabled: false
  };

  render() {
    // ....
  }
}

3.2

没有内部状态，方法或者无需对外暴露ref的组件，使用类静态属性写法。

const HelloMessage = ({ name }) => {
  return 
Hello {name}
;
};

HelloMessage.propTypes = {
  name: React.PropTypes.string
};

HelloMessage.defaultProps = {
  name: 'vic'
};

3.3

PropTypes必须。

State

4.1

使用ES7实例属性提案声明写法或者构造函数声明写法，后者适合需要进行一定计算后才能初始化state的情况。

class Some extends Component {
  state = {
    foo: 'bar'
  };

  // ....
}

class Some extends Component {
  constructor(props) {
    super(props);
      this.state = {
        foo: 'bar'
      };
  }

  // ....
}

4.2

【建议】不建议对this.state进行赋值。

// bad
this.state.name = this.props.name.toUpperCase();

// good
this.setState({
  name: this.props.name.toUpperCase();
});

DisplayName

【建议】为了调试方便，建议在组件最上面写displayName。

// good
class Some extends Component {
  static displayName = 'Some';

  // ....
}

命名

5.1

【强制】扩展名: React组件文件使用.jsx扩展名。

5.2

文件名: 文件名使用驼峰式命名，首字母大写，如ReservationCard.jsx。

5.3

引用命名: React组件名使用驼峰式命名，首字母大写，实例名也使用驼峰式命名，但首字母小写。

// bad
import reservationCard from './ReservationCard';

// good
import ReservationCard from './ReservationCard';

// bad
const ReservationItem = ;

// good
const reservationItem = ;

引号

6.1

对于JSX属性值总是使用双引号", 其他均使用单引号'。

// bad


// good


// bad


// good

空格

7.1

【建议】总是在自闭合的标签/>前加一个空格。

// bad


// very bad


// good

7.2

【建议】不要在JSX{}引用括号里两边加空格。

// bad


// good

7.3

【建议】不要在JSX props属性=两边加空格。

// bad
;

// good
;

属性

8.1

【强制】JSX属性名总是使用驼峰式风格。

// bad


// good

8.2

【建议】如果属性值为true, 可以直接省略。

// bad

8.3

【强制】数组中或者遍历中输出相同的React组件，属性key必需。

// bad
[, , ];

data.map(x => x);

// good
[, , ];

data.map((x, i) => x);

8.4

【强制】class以及for等关键字不允许作为属性名。

// bad
Hello World
;

// good
Hello World
;

8.5

【强制】属性名不允许重复声明。

// bad
;

// good
;

Refs

9.1

【强制】总是在Refs里使用回调函数。

// bad


// good
 { this.myRef = ref; }}
/>

括号

10.1

【建议】将多行的JSX标签写在()里，单行可以省略()。

// bad
render() {
  return 
     
  ;
}

// good
render() {
  return (
    
      
    
  );
}

// good
render() {
  const body = 
hello
;
  return {body};
}

标签

11.1

对于没有子元素的标签来说总是闭合的。

// bad


// good

方法

12.1

render方法必须有值返回。

// bad
render() {
  (
);
}

// good
render() {
  return (
);
}

12.2

【建议】按照以下顺序排序内部方法。

1. static methods and properties
2. lifecycle methods: displayName, propTypes, contextTypes, childContextTypes, mixins, statics,defaultProps, constructor, getDefaultProps, getInitialState, state, getChildContext, componentWillMount, componentDidMount, componentWillReceiveProps, shouldComponentUpdate, componentWillUpdate, componentDidUpdate, componentWillUnmount (in this order).
3. custom methods
4. render method`

12.3

【建议】不要在componentDidMount以及componentDidUpdate中调用setState，除非是在绑定的回调函数中设置State。

// bad
class Hello extends Component {
  componentDidMount() {
    this.setState({
      name: this.props.name.toUpperCase()
    });
  }
  render() {
    return 
Hello {this.state.name}
;
  }
}

// good
class Hello extends Component {
  componentDidMount() {
    this.onMount(newName => {
      this.setState({
        name: newName
      });
    });
  }
  render() {
    return 
Hello {this.state.name}
;
  }
}

12.4

【建议】使用箭头函数来获取本地变量。

function ItemList(props) {
  return (
    

      {props.items.map((item, index) => (
         doSomethingWith(item.name, index)}
        />
      ))}
    
  );
}

12.5

【建议】当在render()里使用事件处理方法时，提前在构造函数里把this绑定上去。

解释：为什么?在每次render过程中， 再调用bind都会新建一个新的函数，浪费资源。

// bad
class extends React.Component {
  onClickDiv() {
    // do stuff
  }

  render() {
    return 

  }
}

// good
class extends React.Component {
  constructor(props) {
    super(props);

    this.onClickDiv = this.onClickDiv.bind(this);
  }

  onClickDiv() {
    // do stuff
  }

  render() {
    return 

  }
}

12.6

【建议】在React模块中，不要给所谓的私有函数添加_前缀，本质上它并不是私有的。

解释：_下划线前缀在某些语言中通常被用来表示私有变量或者函数。但是不像其他的一些语言，在JS中没有原生支持所谓的私有变量，所有的变量函数都是共有的。尽管你的意图是使它私有化，在之前加上下划线并不会使这些变量私有化，并且所有的属性（包括有下划线前缀及没有前缀的）都应该被视为是共有的。了解更多详情请查看Issue #1024，和#490。

// bad
React.createClass({
  _onClickSubmit() {
    // do stuff
  },

  // other stuff
});

// good
class extends React.Component {
  onClickSubmit() {
    // do stuff
  }

  // other stuff
}

参考资料

• Airbnb JavaScript Style Guide - React

---