Vue3+TypeScript完整项目上手教程

一个完整的Vue3+Ts项目,支持.vue和.tsx写法

项目地址:https://github.com/vincentzyc/vue3-demo.git

盈江网站建设公司创新互联,盈江网站设计制作,有大型网站制作公司丰富经验。已为盈江上千家提供企业网站建设服务。企业网站搭建\外贸网站制作要多少钱,请找那个售后服务好的盈江做网站的公司定做!

TypeScript 是JS的一个超集,主要提供了类型系统和对ES6的支持,使用 TypeScript 可以增加代码的可读性和可维护性,在 react 和 vue 社区中也越来越多人开始使用TypeScript。从最近发布的 Vue3 正式版本来看, Vue3 的源码就是用 TypeScript 编写的,更好的 TypeScript 支持也是这一次升级的亮点。当然,在实际开发中如何正确拥抱 TypeScript 也是迁移至 Vue3 的一个小痛点,这里就针对 Vue3 和 TypeScript 展开一些交流。

96.8%的代码都是TypeScript,支持的力度也是相当大

  • Vue3入口: https://github.com/vuejs/vue-next

项目搭建

在官方仓库的 Quickstart 中推荐用两种方式方式来构建我们的 SPA 项目:

  • vite
 
 
 
 
  1. npm init vite-app sail-vue3 # OR yarn create vite-app sail-vue3
  • vue-cli
 
 
 
 
  1. npm install -g @vue/cli # OR yarn global add @vue/clivue create sail-vue3# select vue 3 preset

vite 是一个由原生ESM驱动的Web开发构建工具,打开 vite 依赖的 package.json 可以发现在 devDependencies 开发依赖里面已经引入了TypeScript ,甚至还有 vuex , vue-router , less , sass 这些本地开发经常需要用到的工具。vite 轻量,开箱即用的特点,满足了大部分开发场景的需求,作为快速启动本地 Vue 项目来说,这是一个非常完美的工具。

后面的演示代码也是用vite搭的

从 vue2.x 走过来的掘友肯定知道 vue-cli 这个官方脚手架, vue3 的更新怎么能少得了 vue-cli 呢, vue-cli 更强调的是用 cli 的方式进行交互式的配置,选择起来更加灵活可控。丰富的官方插件适配,GUI的创建管理界面,标准化开发流程,这些都是 vue-cli 的特点。

  • vue-cli TypeScript STEP1 

  • vue-cli TypeScript STEP2

想要预装TypeScript,就需要选择手动配置,并check好TypeScript

忘记使用选择 TypeScript 也没事,加一行cli命令就行了

 
 
 
 
  1. vue add typescript

最后,别忘了在 .vue 代码中,给 script 标签加上 lang="ts"

 
 
 
 
  1.  

Option API风格

在 Vue2.x 使用过 TypeScript 的掘友肯定知道引入 TypeScript 不是一件简单的事情:

  1. 要用 vue-class-component 强化 vue 组件,让 Script 支持 TypeScript 装饰器
  2. 用 vue-property-decorator 来增加更多结合 Vue 特性的装饰器
  3. 引入 ts-loader 让 webpack 识别 .ts .tsx 文件
  4. .....

然后出来的代码风格是这样的:

 
 
 
 
  1. @Component({
  2.     components:{ componentA, componentB},
  3. })
  4. export default class Parent extends Vue{
  5.   @Prop(Number) readonly propA!: number | undefined
  6.   @Prop({ default: 'default value' }) readonly propB!: string
  7.   @Prop([String, Boolean]) readonly propC!: string | boolean | undefined
  8.   // data信息
  9.   message = 'Vue2 code style'
  10.   // 计算属性
  11.   private get reversedMessage (): string[] {
  12.       return this.message.split(' ').reverse().join('')
  13.   }
  14.   // method
  15.   public changeMessage (): void {
  16.     this.message = 'Good bye'
  17.   }
  18. }

class 风格的组件,各种装饰器穿插在代码中,有点感觉自己不是在写 vue ,些许凌乱,所以这种曲线救国的方案在 vue3 里面肯定是行不通的。

在 vue3 中可以直接这么写:

 
 
 
 
  1. import { defineComponent, PropType } from 'vue'
  2. interface Student {
  3.   name: string
  4.   class: string
  5.   age: number
  6. }
  7. const Component = defineComponent({
  8.   props: {
  9.     success: { type: String },
  10.     callback: {
  11.       type: Function as PropType<() => void>
  12.     },
  13.     student: {
  14.       type: Object as PropType,
  15.       required: true
  16.     }
  17.   },
  18.   data() {
  19.      return {
  20.         message: 'Vue3 code style'
  21.     }
  22.   },
  23.   computed: {
  24.     reversedMessage(): string {
  25.       return this.message.split(' ').reverse().join('')
  26.     }
  27.   }
  28. })

vue 对 props 进行复杂类型验证的时候,就直接用 PropType 进行强制转换, data 中返回的数据也能在不显式定义类型的时候推断出大多类型, computed 也只用返回类型的计算属性即可,代码清晰,逻辑简单,同时也保证了 vue 结构的完整性。

Composition API风格

在 vue3 的 Composition API 代码风格中,比较有代表性的api就是 ref 和 reactive ,我们看看这两个是如何做类型声明的:

ref

 
 
 
 
  1. import { defineComponent, ref } from 'vue'
  2. const Component = defineComponent({
  3. setup() {
  4.   const year = ref(2020)
  5.   const month = ref('9')
  6.   month.value = 9 // OK
  7.   const result = year.value.split('') // => Property 'split' does not exist on type 'number'
  8.  }
  9. })

分析上面的代码,可以发现如果我们不给定 ref 定义的类型的话, vue3 也能根据初始值来进行类型推导,然后需要指定复杂类型的时候简单传递一个泛型即可。

Tips:如果只有setup方法的话,可以直接在defineComponent中传入setup函数

 
 
 
 
  1. const Component = defineComponent(() => {
  2.     const year = ref(2020)
  3.     const month = ref('9')
  4.     month.value = 9 // OK
  5.     const result = year.value.split('') // => Property 'split' does not exist on type 'number'
  6. })

reactive

 
 
 
 
  1. import { defineComponent, reactive } from 'vue'
  2. interface Student {
  3.   name: string
  4.   class?: string
  5.   age: number
  6. }
  7. export default defineComponent({
  8.   name: 'HelloWorld',
  9.   setup() {
  10.     const student = reactive({ name: '阿勇', age: 16 })
  11.     // or
  12.     const student: Student = reactive({ name: '阿勇', age: 16 })
  13.     // or
  14.     const student = reactive({ name: '阿勇', age: 16, class: 'cs' }) as Student
  15.   }
  16. })

声明 reactive 的时候就很推荐使用接口了,然后怎么使用类型断言就有很多种选择了,这是 TypeScript 的语法糖,本质上都是一样的。

自定义Hooks

vue3 借鉴 react hooks 开发出了 Composition API ,那么也就意味着 Composition API 也能进行自定义封装 hooks ,接下来我们就用 TypeScript 风格封装一个计数器逻辑的 hooks ( useCount ):

首先来看看这个 hooks 怎么使用:

 
 
 
 
  1. import { ref } from '/@modules/vue'
  2. import  useCount from './useCount'
  3. export default {
  4.   name: 'CountDemo',
  5.   props: {
  6.     msg: String
  7.   },
  8.   setup() {
  9.     const { current: count, inc, dec, set, reset } = useCount(2, {
  10.       min: 1,
  11.       max: 15
  12.     })
  13.     const msg = ref('Demo useCount')
  14.     return {
  15.       count,
  16.       inc,
  17.       dec,
  18.       set,
  19.       reset,
  20.       msg
  21.     }
  22.   }
  23. }

贴上 useCount 的源码:

 
 
 
 
  1. import { ref, Ref, watch } from 'vue'
  2. interface Range {
  3.   min?: number,
  4.   max?: number
  5. }
  6. interface Result {
  7.   current: Ref,
  8.   inc: (delta?: number) => void,
  9.   dec: (delta?: number) => void,
  10.   set: (value: number) => void,
  11.   reset: () => void
  12. }
  13. export default function useCount(initialVal: number, range?: Range): Result {
  14.   const current = ref(initialVal)
  15.   const inc = (delta?: number): void => {
  16.     if (typeof delta === 'number') {
  17.       current.value += delta
  18.     } else {
  19.       current.value += 1
  20.     }
  21.   }
  22.   const dec = (delta?: number): void => {
  23.     if (typeof delta === 'number') {
  24.       current.value -= delta
  25.     } else {
  26.       current.value -= 1
  27.     }
  28.   }
  29.   const set = (value: number): void => {
  30.     current.value = value
  31.   }
  32.   const reset = () => {
  33.     current.value = initialVal
  34.   }
  35.   watch(current, (newVal: number, oldVal: number) => {
  36.     if (newVal === oldVal) return
  37.     if (range && range.min && newVal < range.min) {
  38.       current.value = range.min
  39.     } else if (range && range.max && newVal > range.max) {
  40.       current.value = range.max
  41.     }
  42.   })
  43.   return {
  44.     current,
  45.     inc,
  46.     dec,
  47.     set,
  48.     reset
  49.   }
  50. }

分析源码

这里首先是对 hooks 函数的入参类型和返回类型进行了定义,入参的 Range 和返回的 Result 分别用一个接口来指定,这样做了以后,最大的好处就是在使用 useCount 函数的时候,ide就会自动提示哪些参数是必填项,各个参数的类型是什么,防止业务逻辑出错。

接下来,在增加 inc 和减少 dec 的两个函数中增加了 typeo 类型守卫检查,因为传入的 delta 类型值在某些特定场景下不是很确定,比如在 template 中调用方法的话,类型检查可能会失效,传入的类型就是一个原生的 Event 。

关于 ref 类型值,这里并没有特别声明类型,因为 vue3 会进行自动类型推导,但如果是复杂类型的话可以采用类型断言的方式:ref(initObj) as Ref

小建议

AnyScript

在初期使用 TypeScript 的时候,很多掘友都很喜欢使用 any 类型,硬生生把TypeScript 写成了 AnyScript ,虽然使用起来很方便,但是这就失去了 TypeScript 的类型检查意义了,当然写类型的习惯是需要慢慢去养成的,不用急于一时。

Vetur

vetur 代码检查工具在写vue代码的时候会非常有用,就像构建 vue 项目少不了 vue-cli 一样,vetur 提供了 vscode 的插件支持,赶着升级 vue3 这一波工作,顺带也把 vetur 也带上吧。

一个完整的Vue3+ts项目

├─public
│      favicon.ico
│      index.html
└─src
    │  App.vue
    │  main.ts
    │  shims-vue.d.ts
    ├─assets
    │  │  logo.png
    │  └─css
    │          base.css
    │          main.styl
    ├─components
    │  │  HelloWorld.vue
    │  └─base
    │          Button.vue
    │          index.ts
    │          Select.vue
    ├─directive
    │      focus.ts
    │      index.ts
    │      pin.ts
    ├─router
    │      index.ts
    ├─store
    │      index.ts
    ├─utils
    │  │  cookie.ts
    │  │  deep-clone.ts
    │  │  index.ts
    │  │  storage.ts
    │  └─validate
    │          date.ts
    │          email.ts
    │          mobile.ts
    │          number.ts
    │          system.ts
    └─views
        │  About.vue
        │  Home.vue
        │  LuckDraw.vue
        │  TodoList.vue
        └─address
                AddressEdit.tsx
                AddressList.tsx
  •  vue写法
 
 
 
 
  1. import dayjs from "dayjs";
  2. import { ref, reactive, onMounted } from "vue";
  3. import { Button, Step, Steps, NoticeBar } from "vant";
  4. export default {
  5.   components: {
  6.     Button,
  7.     Step,
  8.     Steps,
  9.     NoticeBar,
  10.   },
  11.   setup() {
  12.     const nameinput = ref();
  13.     const selectionStart = ref(0);
  14.     const twoNow = dayjs().subtract(2, "day").format("YYYY-MM-DD HH:mm:ss");
  15.     const now = dayjs().format("YYYY-MM-DD HH:mm:ss");
  16.     const now2 = dayjs().add(2, "day").format("YYYY-MM-DD HH:mm:ss");
  17.     const formData = reactive({
  18.       name: "",
  19.       phone: "",
  20.       code: "",
  21.     });
  22.     onMounted(() => {
  23.       (nameinput.value as HTMLInputElement).focus();
  24.     });
  25.     const insertName = () => {
  26.       const index = (nameinput.value as HTMLInputElement).selectionStart;
  27.       if (typeof index !== "number") return;
  28.       formData.name =
  29.         formData.name.slice(0, index) + "哈哈" + formData.name.slice(index);
  30.     };
  31.     return {
  32.       nameinput,
  33.       formData,
  34.       insertName,
  35.       selectionStart,
  36.       twoNow,
  37.       now,
  38.       now2,
  39.     };
  40.   },
  41. };
  42.  
 
 
 
 
  1. import dayjs from "dayjs";
  2. import { defineComponent } from "vue";
  3. import HelloWorld from "@/components/HelloWorld.vue"; // @ is an alias to /src
  4. import { Button, Dialog, Toast } from "vant";
  5. export default defineComponent({
  6.   name: "Home",
  7.   components: {
  8.     HelloWorld,
  9.     Button,
  10.   },
  11.   data() {
  12.     return {
  13.       direction: "top",
  14.       pinPadding: 0,
  15.       time: "",
  16.       timer: 0,
  17.       color: "red",
  18.     };
  19.   },
  20.   methods: {
  21.     showToast() {
  22.       Toast("字体颜色已改蓝色");
  23.       this.color = "blue";
  24.     },
  25.     handleClick() {
  26.       Dialog({
  27.         title: "标题",
  28.         message: "这是一个全局按钮组件",
  29.       });
  30.     },
  31.     initTime() {
  32.       this.time = dayjs().format("YYYY-MM-DD HH:mm:ss");
  33.       this.timer = setInterval(() => {
  34.         this.time = dayjs().format("YYYY-MM-DD HH:mm:ss");
  35.       }, 1000);
  36.     },
  37.   },
  38.   created() {
  39.     this.initTime();
  40.   },
  41.   beforeUnmount() {
  42.     clearInterval(this.timer);
  43.   },
  44. });
  45. .text-color {
  46.   color: var(--color);
  47. }
  •  tsx写法
 
 
 
 
  1. import { ref, reactive } from "vue";
  2. import { AddressList, NavBar, Toast, Popup } from "vant";
  3. import AddressEdit from './AddressEdit'
  4. import router from '@/router'
  5. export default {
  6.   setup() {
  7.     const chosenAddressId = ref('1')
  8.     const showEdit = ref(false)
  9.     const list = reactive([
  10.       {
  11.         id: '1',
  12.         name: '张三',
  13.         tel: '13000000000',
  14.         address: '浙江省杭州市西湖区文三路 138 号东方通信大厦 7 楼 501 室',
  15.         isDefault: true,
  16.       },
  17.       {
  18.         id: '2',
  19.         name: '李四',
  20.         tel: '1310000000',
  21.         address: '浙江省杭州市拱墅区莫干山路 50 号',
  22.       },
  23.     ])
  24.     const disabledList = reactive([
  25.       {
  26.         id: '3',
  27.         name: '王五',
  28.         tel: '1320000000',
  29.         address: '浙江省杭州市滨江区江南大道 15 号',
  30.       },
  31.     ])
  32.     const onAdd = () => {
  33.       showEdit.value = true
  34.     }
  35.     const onEdit = (item: any, index: string) => {
  36.       Toast('编辑地址:' + index);
  37.     }
  38.     const onClickLeft = () => {
  39.       router.back()
  40.     }
  41.     const onClickRight = () => {
  42.       router.push('/todoList')
  43.     }
  44.     return () => {
  45.       return (
  46.         
  47.           
  48.             title="地址管理"
  49.             left-text="返回"
  50.             right-text="Todo"
  51.             left-arrow
  52.             onClick-left={onClickLeft}
  53.             onClick-right={onClickRight}
  54.           />
  55.           
  56.             vModel={chosenAddressId.value}
  57.             list={list}
  58.             disabledList={disabledList}
  59.             disabledText="以下地址超出配送范围"
  60.             defaultTagText="默认"
  61.             onAdd={onAdd}
  62.             onEdit={onEdit}
  63.           />
  64.           
  65.             
  66.           
  67.         
  68.       );
  69.     };
  70.   }
  71. };

结束

不知不觉, Vue 都到3的One Piece时代了, Vue3 的新特性让拥抱 TypeScript 的姿势更加从容优雅, Vue 面向大型项目开发也更加有底气了,点击查看更多。

文章题目:Vue3+TypeScript完整项目上手教程
转载源于:http://www.shufengxianlan.com/qtweb/news29/213679.html

网站建设、网络推广公司-创新互联,是专注品牌与效果的网站制作,网络营销seo公司;服务项目有等

广告

声明:本网站发布的内容(图片、视频和文字)以用户投稿、用户转载内容为主,如果涉及侵权请尽快告知,我们将会在第一时间删除。文章观点不代表本网站立场,如需处理请联系客服。电话:028-86922220;邮箱:631063699@qq.com。内容未经允许不得转载,或转载时需注明来源: 创新互联