推啊前端开发规范:
爱彼迎代码规范:
React 编码规约
组件
每个文件只写一个组件,但是多个无状态组件可以放在单个文件中。
【强制】有内部状态,方法或者是要对外暴露ref的组件,使用ES6 Class写法。
// bad
const Listing = React.createClass({
// ...
render() {
return <div>{this.state.hello}</div>;
}
});
// good
class Listing extends React.Component {
// ...
render() {
return <div>{this.state.hello}</div>;
}
}
- 没有内部状态,方法或者是无需对外暴露ref的组件,使用函数写法。
// bad
class Listing extends React.Component {
render() {
return <div>{this.props.hello}</div>;
}
}
// good
const Listing = ({ hello }) => (
<div>{hello}</div>
);
PropTypes/DefaultProps
PropTypes必须
有内部状态,方法或者是要对外暴露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() {
// ....
}
}
- 没有内部状态,方法或者无需对外暴露ref的组件,使用类静态属性写法。
const HelloMessage = ({ name }) => {
return <div>Hello {name}</div>;
};
HelloMessage.propTypes = {
name: React.PropTypes.string
};
HelloMessage.defaultProps = {
name: 'vic'
};
State
- 使用ES7实例属性提案声明写法或者构造函数声明写法,原因:后者适合需要进行一定计算后才能初始化state的情况。
class Some extends Component {
state = {
foo: 'bar'
};
// ....
}
class Some extends Component {
constructor(props) {
super(props);
this.state = {
foo: 'bar'
};
}
// ....
}
- 【强制】不使用 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';
// ....
}
命名
【强制】扩展名: React组件文件使用 .jsx 扩展名。
文件名: 文件名使用驼峰式命名,首字母大写,如 ReservationCard.jsx。
引用命名: React组件名使用驼峰式命名,首字母大写; 实例名也使用驼峰式命名,但首字母小写。
// bad
import reservationCard from './ReservationCard';
// good
import ReservationCard from './ReservationCard';
// bad
const ReservationItem = <ReservationCard />;
// good
const reservationItem = <ReservationCard />;
引号
- 对于JSX属性值总是使用双引号", 其他均使用单引号’。
// bad
<Foo bar='bar' />
// good
<Foo bar="bar" />
// bad
<Foo style={{ left: "20px" }} />
// good
<Foo style={{ left: '20px' }} />
空格
- 【建议】总是在自闭合的标签/>前加一个空格。
// bad
<Foo/>
// very bad
<Foo />
// good
<Foo />
- 【建议】不要在JSX {} 引用括号里两边加空格。
// bad
<Foo bar={ baz } />
// good
<Foo bar={baz} />
- 【建议】不要在JSX props属性 = 两边加空格。
// bad
<Hello name = {firstname} />;
// good
<Hello name={firstname} />;
属性
- 【强制】JSX属性名 总是使用驼峰式风格。
// bad
<Foo UserName="hello" phone_number={12345678} />
// good
<Foo userName="hello" phoneNumber={12345678} />
- 【建议】如果属性值为true, 可以直接省略。
// bad
<Foo hidden={true} />
// good
<Foo hidden />
- 【强制】数组中或者遍历中输出相同的 React 组件,属性 key 必需。
// bad
[<Hello />, <Hello />, <Hello />];
data.map(x => <Hello>x</Hello>);
// good
[<Hello key="first" />, <Hello key="second" />, <Hello key="third" />];
data.map((x, i) => <Hello key={i}>x</Hello>);
- 【强制】class以及for等关键字不允许作为属性名。
// bad
<div class="hello">Hello World</div>;
// good
<div className="hello">Hello World</div>;
- 【强制】属性名不允许重复声明。
// bad
<Hello name="John" name="John" />;
// good
<Hello firstname="John" lastname="Doe" />;
Refs
- 【强制】总是在Refs里使用回调函数。
// bad
<Foo
ref="myRef"
/>
// good
<Foo
ref={ref => { this.myRef = ref; }}
/>
括号
- 【建议】将多行的JSX标签写在 () 里,单行可以省略 ()。
// bad
render() {
return <MyComponent className="long body" foo="bar">
<MyChild />
</MyComponent>;
}
// good
render() {
return (
<MyComponent className="long body" foo="bar">
<MyChild />
</MyComponent>
);
}
// good
render() {
const body = <div>hello</div>;
return <MyComponent>{body}</MyComponent>;
}
标签
- 对于没有子元素的标签来说总是闭合的。
// bad
<Foo className="stuff"></Foo>
// good
<Foo className="stuff" />
方法
- render方法必须有值返回。
// bad
render() {
(<div />);
}
// good
render() {
return (<div />);
}
【建议】按照以下顺序排序内部方法。
- static methods and properties
- lifecycle methods:
- displayName, propTypes, contextTypes, childContextTypes, mixins,
- statics, defaultProps, constructor, getDefaultProps, getInitialState, state, getChildContext, componentWillMount, componentDidMount,componentWillReceiveProps, shouldComponentUpdate, componentWillUpdate, componentDidUpdate, componentWillUnmount (in this order).
- custom methods
- render method
【建议】不要在componentDidMount 以及componentDidUpdate 中调用 setState,除非是在绑定的回调函数中设置State。
// bad
class Hello extends Component {
componentDidMount() {
this.setState({
name: this.props.name.toUpperCase()
});
}
render() {
return <div>Hello {this.state.name}</div>;
}
}
// good
class Hello extends Component {
componentDidMount() {
this.onMount(newName => {
this.setState({
name: newName
});
});
}
render() {
return <div>Hello {this.state.name}</div>;
}
}
- 【建议】使用箭头函数来获取本地变量。
function ItemList(props) {
return (
<ul>
{props.items.map((item, index) => (
<Item
key={item.key}
onClick={() => doSomethingWith(item.name, index)}
/>
))}
</ul>
);
}
【建议】当在render()里使用事件处理方法时,提前在构造函数里把this绑定上去。
解释:为什么?在每次render过程中, 再调用bind都会新建一个新的函数,浪费资源。
// bad
class extends React.Component {
onClickDiv() {
// do stuff
}
render() {
return <div onClick={this.onClickDiv.bind(this)} />
}
}
// good
class extends React.Component {
constructor(props) {
super(props);
this.onClickDiv = this.onClickDiv.bind(this);
}
onClickDiv() {
// do stuff
}
render() {
return <div onClick={this.onClickDiv} />
}
}
【建议】在React模块中,不要给所谓的私有函数添加_前缀,本质上它并不是私有的。
解释:_下划线前缀在某些语言中通常被用来表示私有变量或者函数。但是不像其他的一些语言,在JS中没有原生支持所谓的私有变量,所有的变量函数都是共有的。尽管你的意图是使它私有化,在之前加上下划线并不会使这些变量私有化,并且所有的属性(包括有下划线前缀及没有前缀的)都应该被视为是共有的
// bad
React.createClass({
_onClickSubmit() {
// do stuff
},
// other stuff
});
// good
class extends React.Component {
onClickSubmit() {
// do stuff
}
// other stuff
}