搭建基於vue-cli3+typescript的tsx開發模板

項目建立

使用vue-cli3+建立一個基於ts的模板：

vue-tsx-support

上一步中已經建立完了基於ts的vue模板，可是開發方式仍是如同以前的template同樣，只是將script中的js部分改爲了ts來書寫。接下來就將模板(template)方式改爲tsx的方式，這裏須要藉助一個庫 -- vue-tsx-support

首先安裝vue-tsx-support： 

npm install vue-tsx-support --save
# or
yarn add vue-tsx-support 
複製代碼

安裝結束後，咱們須要對咱們的文件作點小改動，首先咱們在主入口文件main.ts中引入：

// main.ts
import "vue-tsx-support/enable-check";複製代碼

而後刪掉src/shims-tsx.d.ts文件，避免和vue-tsx-support/enable-check聲明重複衝突。

 最後在咱們的vue.config.js文件裏的configureWebpack屬性下增長一項resolve：

// vue.config.js

module.exports = {
  // ...
  configureWebpack: {
    resolve: {
      extensions: [".js", ".vue", ".json", ".ts", ".tsx"] // 加入ts 和 tsx
    }
  }
}複製代碼

這樣就能夠了，接下來就能夠開始開發了。 咱們在/components下新建一個文件button.tsx。而後開始書寫咱們tsx風格的vue代碼： 

// components/button/button.tsx
import { Component, Prop } from "vue-property-decorator";
import * as tsc from "vue-tsx-support";

interface ButtonClick {
  (value: string): void
}

interface ButtonProps {
  text: string;
  btnClick?: ButtonClick
}

@Component
export default class ZButton extends tsc.Component<ButtonProps> {
  @Prop() text!: string;

  public btnClick(value: string): void {
    console.log("value is: ", value);
  }

  protected render() {
    return (
      <div>
        <button onClick={() =>  this.btnClick("click")}>{this.text}</button>
      </div>
    )
  }
}複製代碼

這樣咱們就完成了一個簡單的tsx組件了。 接下來咱們去改寫原來的Home.vue變成Home.tsx：

// views/Home.tsx
import { Component, Vue } from "vue-property-decorator";
import { Component as tsc } from "vue-tsx-support";
import ZButton from "@/components/button/button.tsx";

@Component
export default class HomeContainer extends tsc<Vue> {
  protected render() {
    return <Zbutton text="點我！"></Zbutton>;
  }
}複製代碼

而後運行，能看到如下效果：

就這樣完成了一個簡單的tsx風格的vue項目了。

vue mixins

新建mixins/index.ts，在index.ts中寫一個vue mixin：

// mixins/index.ts
import { Vue, Component } from "vue-property-decorator";

// 這裏必定要作個聲明 否則在組件裏使用的時候會報不存在的錯誤
// 要對應mixin中的屬性和方法
declare module "vue/types/vue" {
  interface Vue {
    mixinText: string;
    showMixinText(): void;
  }
}

@Component
export default class MixinTest extends Vue {
  public mixinText: string = "我是一個mixin";

  public showMixinText() {
    console.log(this.mixinText);
  }
}複製代碼

而後在component/button/button.tsx中使用：

// component/button/button.tsx
import { Component, Prop } from "vue-property-decorator";
import * as tsc from "vue-tsx-support";

import MixinTest from "@/mixins";

interface ButtonClick {
  (value: string): void;
}

interface ButtonProps {
  text: string;
  btnClick?: ButtonClick;
}

// 在Component裝飾器上注入mixin
@Component({
  mixins: [MixinTest]
})
export default class ZButton extends tsc.Component<ButtonProps> {
  @Prop() text!: string;

  public btnClick(value: string): void {
    console.log("value is: ", value);
  }

  // 點擊事件中調用mixin的方法
  protected render() {
    return (
      <div>
        <button onClick={() => this.showMixinText()}>{this.text}</button>
      </div>
    );
  }
}複製代碼

vuex

vuex的ts改造主要有兩種方案，一種是基於vuex-class的方式，一種是基於vue-module-decorators的方式。 這裏我使用的是vuex-class  。

安裝vuex-class：

npm install vue-class --save
#or
yarn add vuex-class複製代碼

新建一個system的module，針對system的store創建各自文件

• state.ts
• getter.ts
  
• mutation-type.ts
• mutation.ts
• action.ts

編寫一個簡單的例子，在vuex中存儲user信息：

// store/modules/system/state.ts

interface SystemState {
  user: Object
}

const state: SystemState = {
  user: {}
}

export default state;複製代碼

// store/modules/system/mutation-type.ts
interface SystemMutationType {
  SET_USER_INFO: String;
}

const Mutation_Type: SystemMutationType = {
  SET_USER_INFO: "SET_USER_INFO"
}

export default Mutation_Type;複製代碼

// store/modules/system/mutation.ts
import type from "./mutation-type";

const mutation: any = {
  [type.SET_USER_INFO as string](state: SystemState, user: Object) {
    state.user = user;
  }
}

export default mutation;複製代碼

import type from "./mutation-type";
import { Commit } from "vuex";

export const cacheUser = (context: { commit: Commit }, user: Object) => {
  context.commit(type.SET_USER_INFO as string, user);
}複製代碼

而後創建一個system的入口文件index.ts將這些外拋出去：

// store/modules/system/index.ts
import state from "./state";
import mutations from "./mutation";
import * as actions from "./action";
import * as getters from "./getter";

export default {
  namespaced: true,
  state,
  getters,
  mutations,
  actions
};複製代碼

最後在store的入口文件處引用該module：

// store/index.ts
import Vue from "vue";
import Vuex from "vuex";
import system from "./modules/system";

Vue.use(Vuex);

export default new Vuex.Store({
  modules: {
    system
  }
});複製代碼

接着咱們去組件button.tsx中使用： 

// components/button/button.tsx
import { Component, Prop } from "vue-property-decorator";
import * as tsc from "vue-tsx-support";
// 引入store命名空間 方便使用某個模塊
import { namespace } from "vuex-class";

// 經過namespace(module name)的方式使用某個模塊的store
const systemStore = namespace("system");

@Component
export default class ZButton extends tsc.Component<ButtonProps> {
  @Prop() text!: string;
  // store使用state和action 其餘getter和mutation類型
  @systemStore.State("user") user!: Object;
  @systemStore.Action("cacheUser") cacheUser: any;

  public btnClick(value: string): void {
    console.log("value is: ", value);
    // 點擊調用store的action方式存儲user信息
    // 而state中的user信息會同步 可經過vue-tools查看
    this.cacheUser({ name: "張三", phone: "13333333333" });
  }

  // 點擊事件中調用mixin的方法
  protected render() {
    return (
      <div>
        <button onClick={() => this.btnClick()}>{this.text}</button>
      </div>
    );
  }
}複製代碼

Tips: 基於typescript的vuex，還在想更優的一種方式。

Ps: 頭一次寫文章，不免有點緊張，若是問題，歡迎討論。感謝~

最終的template在這裏