TS项目中的相关使用

152 阅读3分钟

携手创作,共同成长!这是我参与「掘金日新计划 · 8 月更文挑战」的第2天,点击查看活动详情

vue3中TS在项目开发中的最佳实践

1.Composition Api 必备基础
  • 什么是setup

    setup 是用来配置组件状态的另一种实现。

    在setup 中定义的状态,方法要想在模板中使用,必须 return ;

    setup方法是在components,props data Methods Computed 之前执行;

    setup中是不能访问 this

  • ref 创建响应式变量
    vue2中我们直接是在data中定义;vue3中我们必须在setup中使用ref定义,并且返回,才能在页面中使用。

  1. 引入ref import { ref } from 'vue'
  2. 初始变量 const name = ref('指定默认值')
  3. 返回变量 return { name } 在return中还可以返回方法
  4. 在 setup 中 访问 定义的变量值,不能直接通过变量名来获取, 必须通过 变量名.value 来获取到该对象 、 值
<template>
    <div>
         <h1>{{title}}</h1>
    </div>
</template>

<script>
     
import {ref,defineComponent} from 'vue'

export default defineComponent({

    setup () {
        const title = ref('前端自学社区')  // 定义响应式变量

        console.log(title.value)    // 访问该变量

        return {title}    // 返回变量

     }
 })
</script>

  • 生命周期 Composition Api生命周期钩子 和 Vue 2 选项式 生命周期钩子名称一样,只是在使用 组合式API时,前缀为 on, 例如onMounted

setup () {
    const title = ref('前端自学社区')   // 定义响应式变量

    console.log(title)
     // 返回变量
     function getTitle(){
         console.log(title.value)
     }

     // 页面在加载
    onMounted(getTitle)

    return {title}
},
  • watch

    引入 watch, import { watch } from 'vue'

    直接使用watch,watch 接受 3 个参数

    1. 要监听更新的 响应式引用或者 getter 函数
    2. 一个回调用来做更新后的操作
    3. 可选配置项
import {wathch} from 'vue'
 
    const num = ref(0)   // 定义响应式变量
    // 更新响应式变量
    function changeNum(){
         num.value++
    }
    
     // wathch 监听响应式变量
    watch(num,(newValue, oldValue) => {
         console.log(newValue为:${newValue},--------oldValue为:${oldValue})
    })
  • computed
import {ref,computed} from 'vue';

const num = ref(0)

 //更新num
 function changeNum(){
    num.value++
 }

//监听num变化
const nums = computed(() =>{
    return num.value * 3
})
2.生命周期
选项式 APIHook inside setup
beforeCreate
created
beforeMountonBeforeMount
mountedonMounted
beforeUpdateonBeforeUpdate
updatedonUpdated
beforeUnmountonBeforeUnmount
unmountedonUnmounted
errorCapturedonErrorCaptured
renderTrackedonRenderTracked
renderTriggeredonRenderTriggered
activatedonActivated
deactivatedonDeactivated
3.组件之间的传值

共6种方式:

  • props(父传子)
  • emit(子传父)
  • v-model(子传父)
  • refs(父传子)
  • provide/inject(父传子孙)
  • vuex/pinia(状态管理工具)

1.props

父组件

<template>
  <!-- 子组件 -->
  <child-components :list="list"></child-components>
  
  <!-- 父组件 -->
  <div class="child-wrap input-group">
    <input v-model="value" type="text"  placeholder="请输入"/>
    <div class="input-group-append">
      <button @click="handleAdd"  type="button">添加 </button>
    </div>
  </div>
  
</template>

<script setup>
import { ref } from 'vue'
import ChildComponents from './child.vue'

const list = ref(['JavaScript', 'HTML', 'CSS'])
const value = ref('')
// add 触发后的事件处理函数
const handleAdd = () => {
  list.value.push(value.value)
  value.value = ''
}
</script>

子组件

<template>
  <ul class="parent list-group">
    <li class="list-group-item" v-for="i in props.list" :key="i">{{ i }}</li>
  </ul>
</template>

<script setup>
import { defineProps } from 'vue'
const props = defineProps({
  list: {
    type: Array,
    default: () => [],
  },
})
</script>

2.emit

子组件

<template>
  <div class="child-wrap input-group">
    <input  v-model="value" type="text" placeholder="请输入" />
    <div class="input-group-append">
      <button @click="handleSubmit"  type="button">添加</button>
    </div>
  </div>
</template>

<script setup>
import { ref, defineEmits } from 'vue'
const value = ref('')
const emits = defineEmits(['add'])
const handleSubmit = () => {
  emits('add', value.value)
  value.value = ''
}
</script>

父组件

<template>
  <!-- 父组件 -->
  <ul class="parent list-group">
    <li class="list-group-item" v-for="i in list" :key="i">{{ i }}</li>
  </ul>
  <!-- 子组件 -->
  <child-components @add="handleAdd"></child-components>
</template>

<script setup>
import { ref } from 'vue'
import ChildComponents from './child.vue'
const list = ref(['JavaScript', 'HTML', 'CSS'])
// add 触发后的事件处理函数
const handleAdd = value => {
  list.value.push(value)
}
</script>

3.v-model

父组件

<template>
  <!-- 父组件 -->
  <ul class="parent list-group">
    <li class="list-group-item" v-for="i in list" :key="i">{{ i }}</li>
  </ul>
  <!-- 子组件 -->
  <child-components v-model:list="list"></child-components>
</template>

<script setup>
import { ref } from 'vue'
import ChildComponents from './child.vue'
const list = ref(['JavaScript', 'HTML', 'CSS'])
</script>

子组件

<template>
  <div class="child-wrap input-group">
    <input  v-model="value" type="text" placeholder="请输入" />
    <div class="input-group-append">
      <button @click="handleAdd"  type="button"> 添加 </button>
    </div>
  </div>
</template>

<script setup>
import { ref, defineEmits, defineProps } from 'vue'
const value = ref('')
const props = defineProps({
  list: {
    type: Array,
    default: () => [],
  },
})
const emits = defineEmits(['update:list'])
// 添加操作
const handleAdd = () => {
  const arr = props.list
  arr.push(value.value)
  emits('update:list', arr) // update:* 是Vue中的固定写法,*表示props中的某个属性名
  value.value = ''
}
</script>

注意:<ChildComponent v-model:title="pageTitle" />的简写形式是 <ChildComponent :title="pageTitle" @update:title="pageTitle = $event" />

4.refs

父组件

<template>
  <ul class="parent list-group">
    <li class="list-group-item" v-for="i in childRefs?.list" :key="i">
      {{ i }}
    </li>
  </ul>
  <!-- 子组件 ref的值与<script>中的保持一致 -->
  <child-components ref="childRefs"></child-components>
  <!-- 父组件 -->
</template>
<script setup>
import { ref } from 'vue'
import ChildComponents from './child.vue'
const childRefs = ref(null)
</script>

子组件

<template>
  <div class="child-wrap input-group">
    <input v-model="value" type="text" placeholder="请输入"  />
    <div class="input-group-append">
      <button @click="handleAdd" type="button"> 添加</button>
    </div>
  </div>
</template>

<script setup>
import { ref, defineExpose } from 'vue'
const list = ref(['JavaScript', 'HTML', 'CSS'])
const value = ref('')
// add 触发后的事件处理函数
const handleAdd = () => {
  list.value.push(value.value)
  value.value = ''
}
// setup组件默认是关闭的,也即通过模板ref获取到的组件的公开实例,不会暴露任何在 <script setup> 中声明的绑定。如果需要公开需要通过 defineExpose API暴露
defineExpose({ list })
</script>

5.provide/inject

provide和inject是Vue中提供的一对API,该API可以实现父组件向子组件传递数据,无论层级有多深,都可以通过这对API实现。

父组件

<template>
  <!-- 子组件 -->
  <child-components></child-components>
  <!-- 父组件 -->
  <div class="child-wrap input-group">
    <input v-model="value" type="text" placeholder="请输入" />
    <div class="input-group-append">
      <button @click="handleAdd"  type="button">添加</button>
    </div>
  </div>
</template>

<script setup>
import { ref, provide } from 'vue'
import ChildComponents from './child.vue'
const list = ref(['JavaScript', 'HTML', 'CSS'])
const value = ref('')
// 向子组件提供数据
provide('list', list.value)
// add 触发后的事件处理函数
const handleAdd = () => {
  list.value.push(value.value)
  value.value = ''
}
</script>

子组件

<template>
  <ul class="parent list-group">
    <li class="list-group-item" v-for="i in list" :key="i">{{ i }}</li>
  </ul>
</template>
<script setup>
import { inject } from 'vue'
// 接受父组件提供的数据
const list = inject('list')
</script>

值得注意的是使用provide进行数据传递时,尽量readonly进行数据的包装,避免子组件修改父级传递过去的数据。

6.vuex

Vuex和Pinia是Vue3中的状态管理工具,使用这两个工具可以轻松实现组件通信。

接口返回的数据对象,在TS中使用时要如何做处理?

平时在写代码时,每一个对象都要定义interface吗?例如自己写的一个对象数组,其中的对象要定义成interface时,所有的对象类型在当前页面声明,还是全局声明?

全局可以声明