¶ Vue+TS 踩坑记录与方案总结
¶ 前言
vue 和 TypeScript 结合的情况下,很多写法和我们平时的写法都不太一样
这里总结我项目开发过程中遇到的问题和问题的解决方案
有些问题可能还没解决,欢迎各位大佬给与提点。
使用本文前可以先看vue 官方文档关于 typescript 的使用讲解
¶ 目录结构
说明:整个 vue 项目的目录结构
大体用 vue-cli 创建的项目,结构基本不变。这里只写我后来为了解决问题改动的地方
¶ 一、找不到 App.vue
说明:main.ts 中,提示
import App from './App.vue'
处,找不到 App.vue 这个模块。导致 App.vue 下边“画了红线”
解决方案三步走:
1、将 shims-vue.d.ts 文件一分为二。
2、在 shims-vue.d.ts 文件同级目录下新建 vue.d.ts
(名字不一定叫 vue,如 xxx.d.ts 也可以),然后此文件包含代码如下:
// vue.d.ts
declare module '*.vue' {
import Vue from 'vue'
export default Vue
}
2
3
4
5
3、而原来的 shims-vue.d.ts 代码修改、新增如下:
// shims-vue.d.ts
import Vue from 'vue'
import VueRouter, { Route } from 'vue-router'
import { Store } from 'vuex'
declare module 'vue/types/vue' {
interface Vue {
$router: VueRouter;
$route: Route;
$store: Store<any>;
// 以下是在main.ts中挂载到Vue.prototype上的变量
$api: any;
$mock: any;
$configs: any;
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
¶ 二、prototype 挂载全局变量
说明:main.ts 中,往 Vue 的原型 prototype 上挂载全局变量
解决方案 2 步骤:
1、main.ts 配置:
// main.ts
import api from "./api/request";
import mock from "./api/mock";
import configs from "./utils/config";
Vue.prototype.$api = api;
Vue.prototype.$mock = mock;
Vue.prototype.$configs = configs;
2
3
4
5
6
7
8
2、shims-vue.d.ts 配置:
// shims-vue.d.ts 新增如下
declare module 'vue/types/vue' {
interface Vue {
// ...
// 以下是在main.ts中挂载到Vue.prototype上的变量
$api: any;
$mock: any;
$configs: any;
}
}
2
3
4
5
6
7
8
9
10
¶ 全局组件注册
注册
// main.ts
import Page from "@/components/page.vue";
import AllComponent from "@/common/AllComponent.vue";
Vue.component("Page", Page);
Vue.component("all-component", AllComponent);
2
3
4
5
使用
写法一:
<Page />
写法二:
<all-component />
2
3
4
¶ SFC 文件模板
说明:SFC 单 vue 文件组件的基本写法和结构
一个简陋的 demo,展示 ts 下的 vue 文件中,对于相关功能的使用。
重点关注<Script>
里的代码
<template>
<!-- 结构示例,指令基础用法同vue -->
<div class="minos-system-setting" v-if="hideHeader">
<h3>结构示例</h3>
<span>{{ selfKey1 }}</span>
<ul>
<li :key="item" v-for="item in fatherKey">{{ item }}</li>
</ul>
<button @click="addText">追加文字</button>
<AnotherVue
:class="['default-class', selfKey1.length > 10 ? 'one' : 'two']"
/>
</div>
</template>
<script lang="ts">
import { Component, Vue, Prop, Watch } from "vue-property-decorator";
import { Route } from "vue-router";
import AnotherVue from "@/components/AnotherVue.vue";
@Component({
// 组件注册
components: {
AnotherVue
// 'another-vue': AnotherVue
},
// 过滤器
filters: {
filterFn1() {}
},
// 属性传递
props: {
hideHeader: {
type: Boolean,
required: false,
default: false // 默认属性的默认值
}
}
})
export default class ComponentName extends Vue {
@Prop({
type: Boolean,
required: false,
default: false // 默认属性的默认值
})
private hideHeader!: boolean | undefined;
@Prop() private fatherKey: string[]; // 其他没有默认值的传值
selfKey1: string = "自己的一个变量";
// 生命周期
created() {}
mounted() {}
// 计算属性
get computedKey() {
return this.selfKey1.length;
}
// 监听器
@Watch("computedKey")
getcomputedKey(newVal) {
console.log(newVal);
}
// 导航守卫函数
private beforeRouteEnter(to: Route, from: Route, next: () => void): void {
console.log("beforeRouteEnter", to, from, next);
next();
}
// 方法
addText() {
this.selfKey1 += ",追加文字!";
}
}
</script>
<style lang="scss" scoped>
@import "@/assets/styles/demo.scss";
</style>
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
¶ filter
vue+ts 中,使用 filter 过滤器
1、定义:(在@Component 里边,写 filters,注意 s 单词)
<script lang="ts">
import { Component, Vue, Prop } from "vue-property-decorator";
@Component({
filters: {
filterValue(value) {
return Number(value).toLocaleString();
}
// otherFilterFn(value) { 其他filter示例
// return ...
// }
},
components: {}
})
export default class Container extends Vue {
// ...
}
</script>
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2、使用:同之前,正常使用
<!-- html中 -->
<span v-if="showSpan">{{showValue | filterValue}}</span>
2
¶ 自定义指令
自定义指令 过滤器【待补充】
// 待补充
¶ computed
说明:computed 计算属性的写法
// 计算属性
get computedKey() {
return this.selfKey1.length
}
2
3
4
¶ watch
说明:watch 监听器的使用
¶ 一、单页面监听
同一个 vue 页面中使用 Watch 监听本页面某数据的改变:
import { Component, Vue, Prop, Watch } from 'vue-property-decorator'
@Watch('boxHeight')
getboxHeight(val) { // get+上边括号里的名字
// xxx
}
2
3
4
5
6
¶ 二、父子传值监听
父子两个 vue 页面传值后使用 watch 监听。子组件监听从父组件传过来的值,需要如下五个关键步骤:
- 1、父组件用属性传值【前提是父组件引入子组件、注册并调用了】
<ziZuJian :oneKey="oneKeyObj" />
- 2、子组件引入要使用的
Prop, Watch
import { Component, Vue, Prop, Watch } from "vue-property-decorator";
- 3、子组件 Prop 接受父组件传过来的值
export default class ZiZuJian extends Vue {
@Prop() private oneKey: object
}
2
3
- 4、子组件 Watch 监听父组件传过来的值
@Watch('oneKey')
getoneKey(newVal,oldVal) {
// 监听成功后要做
log(newVal)
this.myfunction(newVal)
}
2
3
4
5
6
- 5、父组件(内部)改动值,会被子组件监听,做后续操作
// 如下代码模拟父组件中,值被改变的情况
export default class FuZuJian extends Vue {
oneKeyObj = {}
...
mounted(){
$.ajax().then(()=>{
// 适时情况下改动props传递的值,就会被子组件监听到改变
oneKeyObj = {
name : '测试'
}
oneKeyObj.age = 18
})
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
¶ Watch 监听 store
Watch 监听 store 中的数据改变
主要思路是计算属性获取 state 里的数据,watch 再监听计算属性
import { Component, Vue, Prop, Watch } from 'vue-property-decorator' // 引入Watch
get stateSomeKey() { // 计算属性
// 监听state下的stateSomeKey对象中的keyName属性,return返回该值
return this['$store'].state.stateSomeKey.keyName
}
@Watch('stateSomeKey') // 与上边计算属性同名
getstateSomeKey(val) { // get+上边括号里的名字
// 监听到变化后,执行对应的内容
this.myFunction()
...
}
2
3
4
5
6
7
8
9
10
11
其中,第七行,监听器那里也可以这么写:
@Watch('stateSomeKey') // 与上边计算属性同名
watchMenuState(val) { // 这里可以这么写:或用watch+上边括号里的名字也可以(虽然不太确定为什么,只是代码这么写成功了)
// 下同
// ...
}
2
3
4
5
¶ watch 监听 router
watch 监听 router 的变化
三个关键步骤设置如下:
- 1、shims-vue.d.ts 的设置
// shims-vue.d.ts
import Vue from 'vue'
import VueRouter, {Route} from 'vue-router';
declare module 'vue/types/vue' {
interface Vue {
$router: VueRouter; // 这表示this下有这个东西
$route: Route;
}
}
2
3
4
5
6
7
8
9
10
- 2、main.ts 的设置
// main.ts
import { Component } from "vue-class-component";
Vue.config.productionTip = false;
Component.registerHooks([
"beforeRouteEnter", //进入路由之前
"beforeRouteLeave", //离开路由之前
"beforeRouteUpdate"
]);
2
3
4
5
6
7
8
- 3、需要监听路由钩子的 SCF 组件:
<script lang="ts">
// xxx.vue 的script标签内
import { Component, Vue, Prop, Watch } from "vue-property-decorator";
import { Route, RawLocation } from 'vue-router';
// # 下边两段,看你需要什么就选哪段代码:
// 1、监听路由变化
@Watch('$route',{ immediate: true })
private changeRouter(route: Route){
console.log(route)
}
// 2、定义路由钩子函数
private beforeRouteEnter(to: Route, from: Route, next: () => void): void {
console.log('beforeRouteEnter', to, from, next)
next(); // 没有next将不会进入路由内部,跟vue文档用法一致
}
private beforeRouteUpdate(to: Route, from: Route, next: () => void): void {
console.log('beforeRouteUpdate'); // 暂时不生效,版本问题
next();
}
private beforeRouteLeave(to: Route, from: Route, next: () => void): void {
console.log('beforeRouteLeave');
next();
}
</script>
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
¶ 监听路由的第二种写法
(如果只是想更新视图的话可以考虑监听路由)
@Watch('$route')
routeWatch() {
this.loadData();
}
2
3
4
¶ router 导航守卫与钩子函数
main.ts 中注册路由导航守卫并在组件中使用路由钩子函数
基本同上,需要三步
- 1、shims-vue.d.ts 的设置
// shims-vue.d.ts
import Vue from 'vue'
import VueRouter, {Route} from 'vue-router';
declare module 'vue/types/vue' {
interface Vue {
$router: VueRouter; // 这表示this下有这个东西
$route: Route;
}
}
2
3
4
5
6
7
8
9
10
- 2、main.ts 的设置
// main.ts
import { Component } from "vue-class-component";
Component.registerHooks([
"beforeRouteEnter", //进入路由之前
"beforeRouteLeave", //离开路由之前
"beforeRouteUpdate"
]);
2
3
4
5
6
7
- 3、需要监听路由钩子的 SCF 组件:
<script lang="ts">
// xxx.vue 的script标签内
import { Component, Vue, Prop, Watch } from "vue-property-decorator";
import { Route, RawLocation } from 'vue-router';
// # 下边两段,看你需要什么了:
// 1/监听路由变化
@Watch('$route',{ immediate: true })
private changeRouter(route: Route){
console.log(route)
}
// 2/定义路由钩子函数
private beforeRouteEnter(to: Route, from: Route, next: () => void): void {
console.log('beforeRouteEnter', to, from, next)
next(); // 没有next将不会进入路由内部,跟vue文档用法一致
}
private beforeRouteUpdate(to: Route, from: Route, next: () => void): void {
console.log('beforeRouteUpdate'); // 暂时不生效,版本问题
next();
}
private beforeRouteLeave(to: Route, from: Route, next: () => void): void {
console.log('beforeRouteLeave');
next();
}
</script>
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
¶ 父子传值
说明:父子传值 - 子组件修改触发父组件的方法执行
父组件内部:
1、调用子组件、并绑定传值:
<!-- 引入、注册子组件后,调用子组件: -->
<ZiZuJian @chuanDiGuoQu="FuQinZiJiYong"></ZiZuJian>
2
2、准备好一会会被子组件触发的函数:
FuQinZiJiYong(){
console.log('我是父亲内部待被触发的方法')
}
2
3
子组件 ZiZuJian 内部:
1、在需要触发的地方执行$emit
export default class Menu extends Vue {
// 在需要触发的地方,执行如下代码
this.$emit('chuanDiGuoQu', '传参')
}
2
3
4
最后还有另一种网友总结很麻烦的写法:参见地址
¶ @Prop 默认参数
¶ 一、TS 写法
github 找到的 demo 这样。如下代码中hideHeader
就是由默认参数的父组件传过来的属性
export default class ComponentName extends Vue {
@Prop({
type: Boolean,
required: false,
default: false // 默认属性的默认值
})
private hideHeader!: boolean | undefined
}
2
3
4
5
6
7
8
¶ 二、VUE 原生写法
vue 原生的写法,写到了@component 构造器中就好了:
@Component({
props: {
hideHeader: {
type: Boolean,
required: false,
default: false // 默认属性的默认值
}
}
})
// 如果不传值此函数默认就是 true,传 false 就是 false 了。
// 并且能严格判断只能传 Boolean 类型。挺好。
2
3
4
5
6
7
8
9
10
11
¶ @Prop 多类型定义
说明:如果 prop 接受的参数,有多个类型传递的需要,可以这么定义
export default class ComponentName extends Vue {
@Prop({
type: [Boolean,Number], // 有数字和布尔两种参数可能性
required: true, // 必传
default: true // 默认值为true
})
private hideHeader!: boolean | number
}
2
3
4
5
6
7
8
¶ 中央总线
说明:中央总线注册与使用【待解决】
// 待解决
¶ vue-echarts 使用
说明:vue + ts 中使用 vue-echarts
¶ 1、模块安装
npm i -S vue-echarts echarts
¶ 2、引入与注册
main.ts 中:
// main.ts
// 引用
import ECharts from "vue-echarts";
// 用到的模块要单独引用
import "echarts/lib/chart/line"; // 线图为例,其他图一样
import "echarts/lib/component/title.js"; // 标题
import "echarts/lib/component/legend"; // 图例
import "echarts/lib/component/tooltip"; // 提示框
import "echarts/lib/component/toolbox"; // 工具(如下载功能与按钮)
// 注册
Vue.component("v-chart", ECharts);
2
3
4
5
6
7
8
9
10
11
12
¶ 3、vue.config 配置
vue.config.js 中设置:
// vue.config.js
module.exports = {
// For Vue CLI 3+, add vue-echarts and resize-detector into transpileDependencies in vue.config.js like this:
transpileDependencies: ["vue-echarts", "resize-detector"]
};
2
3
4
5
¶ 4、tsconfig 配置
tsconfig.json 中也要设置
// tsconfig.json
{
"compilerOptions": {
"types": ["webpack-env", "echarts"]
}
}
2
3
4
5
6
¶ 5、SFC 中使用
<v-chart :options="echartsOptions" id="myCharts" ref="myCharts" />
¶ Element-ui 使用
说明:vue + ts 中使用 Element-ui
详细步骤可看 element 官网文档
¶ 1、安装
npm i element-ui -S
¶ 2、引入与注册
// main.ts 模块引入与注册
import ElementUI from "element-ui";
Vue.use(ElementUI);
2
3
¶ 全局 scss 变量
在 assets/styles 下新建 _variable.scss 文件(文件名自定义),用于存放 scss 变量。
然后于 vue.config.js 中设置全局变量
// vue.config.js
module.exports = {
css: {
loaderOptions: {
sass: {
prependData: `
@import "@/assets/styles/_variable.scss";
`
}
}
}
};
2
3
4
5
6
7
8
9
10
11
12
¶ alias 别名设置
同时解决问题alias 配置的路径别名,在 vscode 中报错模块查找失败
和问题vue-cli 配置了 resolve alias 来声明的路径别名,在引用了 ts 后,vscode 会报错不能识别、模块查找失败
。
其中,vscode 报错在 win 环境还需要一个插件安装,解决方案见下边
¶ 1、vue.config.js 配置
// vue.config.js
module.exports = {
chainWebpack: config => {
// 别名配置
config.resolve.alias
.set("comp", resolve("src/components"))
.set("css", resolve("src/assets/styles"));
// ...同上,路径核对好就行
}
};
2
3
4
5
6
7
8
9
10
¶ 2、jsconfig.json 配置
注意这里的名字要和上边 set 后边的名字保持一致
// jsconfig.json
{
"compilerOptions": {
"paths": {
"@/*": [
"src/*" // 这个本来就有
],
// 后边追加
"comp/*": [
"src/components/*"
],
"css/*": [
"src/assets/styles/*"
],
// ... 同上,路径核对好就行
},
}
};
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
¶ 3、SCF 使用设定的别名
// main.ts中使用
import MyError from "view/error/Error.vue";
2
/* SCF单页中scss路径引用 */
@import "css/_variable.scss";
2
¶ 后端接口代理
说明:请求接口的代理设置
¶ 1、vue.config.js 配置
// vue.config.js
module.exports = {
devServer: {
proxy: {
"/api": {
target: "http://11.11.11.111/", // 示例ip地址,也可以填域名,需要的是后端接口地址的相同部分
changeOrigin: true,
pathRewrite: {
"^/api": ""
}
}
}
}
};
2
3
4
5
6
7
8
9
10
11
12
13
14
¶ 2、axios 地址参数
注意/api
一定要有,且在路径的最前边,代替相同的路径。
axios
.get("/api/my/url") // 前边的'/api'一定要有,它代表的就是vue.config.js中proxy.target的路径
.then(() => {
// 接口成功...
});
2
3
4
5
¶ 开发环境域名
说明:本地服务域名修改,用域名代替 https//localhost:8080 的访问地址
¶ 1、vue.config 配置
// vue.config.js
module.exports = {
devServer: {
disableHostCheck: true, // 用域名代替localhost,禁用主机检查
host: "www.haha.com"
// 另外端口也可以在这里改,只不过我写到了package.json总,见下边
}
};
2
3
4
5
6
7
8
¶ 2、package.json 配置
开发命令配置
{
"scripts": {
"dev": "npm run serve",
"serve": "vue-cli-service serve --port 80 --open", # 端口设置为80,--open运行完毕后自动打开地址
}
}
2
3
4
5
6
¶ 3、本地 host 配置
127.0.0.1 www.haha.com # 这里注意和vue.config.js中的host的值对应
¶ 4、访问地址
此时,npm run dev
成功后,浏览器跑项目输入地址http://www.haha.com
即可
¶ vscode 中的问题
说明: vue + ts 在 vscode 中的问题
¶ 一、找不到模块
说明:别名引入模块不能识别。vue-cli 配置了 resolve alias 来声明的路径别名,在引用了 ts 后,vscode 会报错不能识别、模块查找失败:
1、扩展商店安装插件 - Path Intellisense
2、配置代码(vscode setting.json 中设置)
"path-intellisense.mappings": {
"@": "\${workspaceRoot}/src"
}
2
3
- 3、在 package.json 统计目录下创建 jsconfig.json 文件,并填入下边代码
// jsconfig.json
{
"compilerOptions": {
"paths": {
"@/*": ["src/*"]
}
}
}
2
3
4
5
6
7
8