关于前端:组员重构代码千奇百怪直接JSES6和Vue规范给一梭子

31次阅读

共计 10261 个字符，预计需要花费 26 分钟才能阅读完成。

近期组员接手了一个“古老“的初始由后端大佬写的前端我的项目，业务层面的组件复用，全靠是 copy 雷同代码咱不说，通过不同大佬们的保护，代码格调更是千奇百怪。该前端我的项目还在失常迭代更新，又不可能重写，面对 💩 一样的代码，两个接手的小前端抱着欲哭无泪，瑟瑟发抖。见状，只能刺激之，临时施展啊 Q 精力，标准本人的新代码，而后每次迭代开发工作重构一两个旧组件，此过程继续 2-3 个月后，上 eslint 和 prettier 自动化检测语法和格式化代码。
本着“代码不标准，新人两行泪”的警示，总结出如下 JavaScrip、ES6 和 Vue 单文件组件相干代码格调案例，供大家参考。

变量的名称应该是可形容，有意义的，JavaScript 变量都应该采纳驼峰式大小写 (camelCase) 命名。

// bad ❌
const foo = 'JDoe@example.com'
const bar = 'John'
const age = 23
const qux = true

// good ✅
const email = 'John@example.com'
const firstName = 'John'
const age = 23
const isActive = true

布尔变量通常须要答复特定问题，例如：

isActive
didSubscribe
hasLinkedAccount

当对象或类曾经蕴含了上下文的命名时，不要再向变量名称增加冗余的上下文。

// bad ❌
const user = {
  userId: '296e2589-7b33-400a-b762-007b730c8e6d',
  userEmail: 'JDoe@example.com',
  userFirstName: 'John',
  userLastName: 'Doe',
  userAge: 23
}

user.userId

//good ✅
const user = {
  id: '296e2589-7b33-400a-b762-007b730c8e6d',
  email: 'JDoe@example.com',
  firstName: 'John',
  lastName: 'Doe',
  age: 23
}

user.id

// bad ❌
setTimeout(clearSessionData, 900000)

//good ✅
const SESSION_DURATION_MS = 15 * 60 * 1000

setTimeout(clearSessionData, SESSION_DURATION_MS)

函数名称须要形容函数的理论作用，即便很长也没关系。函数名称通常应用动词，但返回布尔值的函数可能是个例外 — 它能够采纳 是或否 问题的模式，函数名也应该是驼峰式的。

// bad ❌
function toggle() {// ...}

function agreed(user) {// ...}

//good ✅
function toggleThemeSwitcher() {// ...}

function didAgreeToAllTerms(user) {// ...}

只管这条规定可能有争议，但函数最好是有 3 个以下参数。如果参数较多可能是以下两种状况之一：

该函数做的事件太多，应该拆分。
传递给函数的数据以某种形式相干，能够作为专用数据结构传递。

// bad ❌
function sendPushNotification(title, message, image, isSilent, delayMs) {// ...}

sendPushNotification('New Message', '...', 'http://...', false, 1000)

//good ✅
function sendPushNotification({title, message, image, isSilent, delayMs}) {// ...}

const notificationConfig = {
  title: 'New Message',
  message: '...',
  image: 'http://...',
  isSilent: false,
  delayMs: 1000
}

sendPushNotification(notificationConfig)

一个函数应该一次做一件事，这有助于缩小函数的大小和复杂性，使测试、调试和重构更容易。

// bad ❌
function pingUsers(users) {users.forEach((user) => {const userRecord = database.lookup(user)
    if (!userRecord.isActive()) {ping(user)
    }
  })
}

//good ✅
function pingInactiveUsers(users) {users.filter(!isUserActive).forEach(ping)
}

function isUserActive(user) {const userRecord = database.lookup(user)
  return userRecord.isActive()}

函数含有布尔标记的参数象征这个函数是能够被简化的。

// bad ❌
function createFile(name, isPublic) {if (isPublic) {fs.create(`./public/${name}`)
  } else {fs.create(name)
  }
}

//good ✅
function createFile(name) {fs.create(name)
}

function createPublicFile(name) {createFile(`./public/${name}`)
}

如果你写了反复的代码，每次有逻辑扭转，你都须要改变多个地位。

// bad ❌
function renderCarsList(cars) {cars.forEach((car) => {const price = car.getPrice()
    const make = car.getMake()
    const brand = car.getBrand()
    const nbOfDoors = car.getNbOfDoors()

    render({price, make, brand, nbOfDoors})
  })
}

function renderMotorcyclesList(motorcycles) {motorcycles.forEach((motorcycle) => {const price = motorcycle.getPrice()
    const make = motorcycle.getMake()
    const brand = motorcycle.getBrand()
    const seatHeight = motorcycle.getSeatHeight()

    render({price, make, brand, nbOfDoors})
  })
}

//good ✅
function renderVehiclesList(vehicles) {vehicles.forEach((vehicle) => {const price = vehicle.getPrice()
    const make = vehicle.getMake()
    const brand = vehicle.getBrand()

    const data = {price, make, brand}

    switch (vehicle.type) {
      case 'car':
        data.nbOfDoors = vehicle.getNbOfDoors()
        break
      case 'motorcycle':
        data.seatHeight = vehicle.getSeatHeight()
        break
    }

    render(data)
  })
}

在 JavaScript 中，你应该更喜爱函数式模式而不是命令式模式。换句话说，大多数状况下咱们都应该放弃函数纯净。副作用可能会批改共享状态和资源，从而导致一些奇怪的问题。所有的副作用都应该集中管理，例如你须要更改全局变量或批改文件，能够专门写一个 util 来做这件事。

// bad ❌
let date = '21-8-2021'

function splitIntoDayMonthYear() {date = date.split('-')
}

splitIntoDayMonthYear()

// Another function could be expecting date as a string
console.log(date) // ['21', '8', '2021'];

//good ✅
function splitIntoDayMonthYear(date) {return date.split('-')
}

const date = '21-8-2021'
const newDate = splitIntoDayMonthYear(date)

// Original vlaue is intact
console.log(date) // '21-8-2021';
console.log(newDate) // ['21', '8', '2021'];

另外，如果你将一个可变值传递给函数，你应该间接克隆一个新值返回，而不是间接扭转该它。

// bad ❌
function enrollStudentInCourse(course, student) {course.push({ student, enrollmentDate: Date.now() })
}

//good ✅
function enrollStudentInCourse(course, student) {return [...course, { student, enrollmentDate: Date.now() }]
}

// bad ❌
function isUserNotVerified(user) {// ...}

if (!isUserNotVerified(user)) {// ...}

//good ✅
function isUserVerified(user) {// ...}

if (isUserVerified(user)) {// ...}

// bad ❌
if (isActive === true) {// ...}

if (firstName !== '' && firstName !== null && firstName !== undefined) {// ...}

const isUserEligible = user.isVerified() && user.didSubscribe() ? true : false

//good ✅
if (isActive) {// ...}

if (!!firstName) {// ...}

const isUserEligible = user.isVerified() && user.didSubscribe()

尽早 return 会使你的代码线性化、更具可读性且不那么简单。

// bad ❌
function addUserService(db, user) {if (!db) {if (!db.isConnected()) {if (!user) {return db.insert('users', user)
      } else {throw new Error('No user')
      }
    } else {throw new Error('No database connection')
    }
  } else {throw new Error('No database')
  }
}

//good ✅
function addUserService(db, user) {if (!db) throw new Error('No database')
  if (!db.isConnected()) throw new Error('No database connection')
  if (!user) throw new Error('No user')

  return db.insert('users', user)
}

既能缩小复杂度又能晋升性能。

// bad ❌
const getColorByStatus = (status) => {switch (status) {
    case 'success':
      return 'green'
    case 'failure':
      return 'red'
    case 'warning':
      return 'yellow'
    case 'loading':
    default:
      return 'blue'
  }
}

//good ✅
const statusColors = {
  success: 'green',
  failure: 'red',
  warning: 'yellow',
  loading: 'blue'
}

const getColorByStatus = (status) => statusColors[status] || 'blue'

const user = {
  email: 'JDoe@example.com',
  billing: {
    iban: '...',
    swift: '...',
    address: {
      street: 'Some Street Name',
      state: 'CA'
    }
  }
}

// bad ❌
const email = (user && user.email) || 'N/A'
const street = (user && user.billing && user.billing.address && user.billing.address.street) || 'N/A'
const state = (user && user.billing && user.billing.address && user.billing.address.state) || 'N/A'

//good ✅
const email = user?.email ?? 'N/A'
const street = user?.billing?.address?.street ?? 'N/A'
const street = user?.billing?.address?.state ?? 'N/A'

回调很凌乱，会导致代码嵌套过深，应用 Promise 代替回调。

// bad ❌
getUser(function (err, user) {getProfile(user, function (err, profile) {getAccount(profile, function (err, account) {getReports(account, function (err, reports) {sendStatistics(reports, function (err) {console.error(err)
        })
      })
    })
  })
})

//good ✅
getUser()
  .then(getProfile)
  .then(getAccount)
  .then(getReports)
  .then(sendStatistics)
  .catch((err) => console.error(err))

// or using Async/Await ✅✅

async function sendUserStatistics() {
  try {const user = await getUser()
    const profile = await getProfile(user)
    const account = await getAccount(profile)
    const reports = await getReports(account)
    return sendStatistics(reports)
  } catch (e) {console.error(err)
  }
}

// bad ❌
try {// Possible erronous code} catch (e) {console.log(e)
}

//good ✅
try {// Possible erronous code} catch (e) {// Follow the most applicable (or all):
  // 1- More suitable than console.log
  console.error(e)

  // 2- Notify user if applicable
  alertUserOfError(e)

  // 3- Report to server
  reportErrorToServer(e)

  // 4- Use a custom error handler
  throw new CustomError(e)
}

// bad ❌
function generateHash(str) {
  // Hash variable
  let hash = 0

  // Get the length of the string
  let length = str.length

  // If the string is empty return
  if (!length) {return hash}

  // Loop through every character in the string
  for (let i = 0; i < length; i++) {
    // Get character code.
    const char = str.charCodeAt(i)

    // Make the hash
    hash = (hash << 5) - hash + char

    // Convert to 32-bit integer
    hash &= hash
  }
}

// good ✅
function generateHash(str) {
  let hash = 0
  let length = str.length
  if (!length) {return hash}

  for (let i = 0; i < length; i++) {const char = str.charCodeAt(i)
    hash = (hash << 5) - hash + char
    hash = hash & hash // Convert to 32bit integer
  }
  return hash
}

// bad ❌
function printAllFilesInDirectory(dir) {
  const directory = dir || './'
  //   ...
}

// good ✅
function printAllFilesInDirectory(dir = './') {// ...}

const obj = {
  a: 1,
  b: 2,
  c: 3,
  d: 4,
  e: 5
}

// bad ❌
const f = obj.a + obj.d
const g = obj.c + obj.e

// good ✅
const {a, b, c, d, e} = obj
const f = a + d
const g = c + e

ES6 的解构赋值尽管好用。然而要留神解构的对象不能为 undefined、null。否则会报错，故要给被解构的对象一个默认值。

const {a, b, c, d, e} = obj || {}

合并数组或者对象，用 ES5 的写法有些冗余

const a = [1, 2, 3]
const b = [1, 5, 6]
const obj1 = {a: 1}
const obj2 = {b: 1}

// bad ❌
const c = a.concat(b) //[1,2,3,1,5,6]
const obj = Object.assign({}, obj1, obj2) // {a:1, b:1}

// good ✅
const c = [...new Set([...a, ...b])] //[1,2,3,5,6]
const obj = {...obj1, ...obj2} // {a:1, b:1}

const name = '小明'
const score = 59

// bad ❌
let result = ''
if (score > 60) {result = `${name} 的考试成绩及格 `
} else {result = `${name} 的考试成绩不及格 `
}

// good ✅
const result = `${name}${score > 60 ? '的考试成绩及格' : '的考试成绩不及格'}`

// bad ❌
f(
    type == 1 ||
    type == 2 ||
    type == 3 ||
    type == 4 ||
){//...}

// good ✅
const condition = [1,2,3,4];

if(condition.includes(type) ){//...}

const a = [1, 2, 3, 4, 5]

// bad ❌
const result = a.filter((item) => {return item === 3})

// good ✅
const result = a.find((item) => {return item === 3})

// bad ❌
const deps = {采购部: [1, 2, 3],
  人事部: [5, 8, 12],
  行政部: [5, 14, 79],
  运输部: [3, 64, 105]
}
let member = []
for (let item in deps) {const value = deps[item]
  if (Array.isArray(value)) {member = [...member, ...value]
  }
}
member = [...new Set(member)]

// good ✅
const member = Object.values(deps).flat(Infinity)

// bad ❌
const name = obj && obj.name

// good ✅
const name = obj?.name

// bad ❌
let obj = {}
let index = 1
let key = `topic${index}`
obj[key] = '话题内容'

// good ✅
obj[`topic${index}`] = '话题内容'

// bad ❌
if (value !== null && value !== undefined && value !== '') {//...}

// good ✅
if ((value ?? '') !=='') {//...}

Vue 单文件组件格调指南内容节选自 Vue 官网格调指南。

组件的 data 必须是一个函数。

// bad
export default {
  data: {foo: 'bar'}
};

// good
export default {data() {
    return {foo: 'bar'};
  }
};

单文件组件的文件名应该要么始终是单词大写结尾 (PascalCase)，要么始终是横线连贯 (kebab-case)。

// bad
mycomponent.vue
myComponent.vue

// good
my - component.vue
MyComponent.vue

和父组件严密耦合的子组件应该以父组件名作为前缀命名。

// bad
components/
|- TodoList.vue
|- TodoItem.vue
└─ TodoButton.vue

// good
components/
|- TodoList.vue
|- TodoListItem.vue
└─ TodoListItemButton.vue

在单文件组件中没有内容的组件应该是自闭合的。

<!-- bad -->
<my-component></my-component>

<!-- good -->
<my-component />

在申明 prop 的时候，其命名应该始终应用 camelCase，而在模板中应该始终应用 kebab-case。

// bad
export default {
  props: {'greeting-text': String}
};

// good
export default {
  props: {greetingText: String}
};

<!-- bad -->
<welcome-message greetingText="hi" />

<!-- good -->
<welcome-message greeting-text="hi" />

指令缩写，用 : 示意 v-bind:，用 @ 示意 v-on:

<!-- bad -->
<input v-bind:value="value" v-on:input="onInput" />

<!-- good -->
<input :value="value" @input="onInput" />

标签的 Props 应该有对立的程序，顺次为指令、属性和事件。

<my-component
  v-if="if"
  v-show="show"
  v-model="value"
  ref="ref"
  :key="key"
  :text="text"
  @input="onInput"
  @change="onChange"
/>

组件选项应该有对立的程序。

export default {
  name: '',

  components: {},

  props: {},

  emits: [],

  setup() {},

  data() {},

  computed: {},

  watch: {},

  created() {},

  mounted() {},

  unmounted() {},

  methods: {}}

组件选项较多时，倡议在属性之间增加空行。

export default {
  computed: {formattedValue() {// ...},

    styles() {// ...}
  },

  methods: {onInput() {// ...},

    onChange() {// ...}
  }
}

单文件组件应该总是让顶级标签的程序保持一致，且标签之间留有空行。

<template> ... </template>

<script>
  /* ... */
</script>

<style>
  /* ... */
</style>

正文完

前端

发表至：前端

2022-02-22

0

关于前端:自学前端8个月找到一份7K的工作学习经验分享

关于前端:现代JavaScript高级教程JavaScript对象

关于前端:立体声耳机功率放大器电路D7000静态电流低且电源纹波抑制比高

关于前端:esbuild-为什么这么快

关于前端:面试官你都工作3年了这个算法题都不会

关于前端:组员重构代码千奇百怪直接JSES6和Vue规范给一梭子

前言

Javascript 代码格调

应用有意义的变量名称

防止增加不必要的上下文

防止硬编码值

应用有意义的函数名称

限度参数的数量

防止在一个函数中做太多事件

防止应用布尔标记作为参数

防止写反复的代码

防止副作用

应用非负条件

尽可能应用简写

防止过多分支

优先应用 map 而不是 switch 语句

应用可选链接

防止回调

解决抛出的谬误和 reject 的 promise

只正文业务逻辑

ES6 优化原生 JS（ES5）代码格调

应用默认参数

对象构造取值

拓展运算符合并数据

拼接字符

includes 代替多条件判断

列表查找某一项

数组扁平化

可选链操作符获取对象属性值

动静对象属性名

判断非空

Vue 组件格调

组件数据

单文件组件文件名称

严密耦合的组件名

自闭合组件

Prop 名大小写

指令缩写

Props 程序

组件选项的程序

组件选项中的空行

单文件组件顶级标签的程序

Just My Socks（注册教程 内含优惠码）

Just My Socks（注册教程内含优惠码）