# game

**Repository Path**: allex/game

## Basic Information

- **Project Name**: game
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-06-25
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


<div align=center>
    <img src="https://p1.meituan.net/dpgroup/60168751a8f4a79ca3c59edffdde00e423571.jpg" width="126"/>
    <img src="https://p0.meituan.net/dpgroup/4a48f7ad4e6231c12c44b3422d67008116085.jpg" width="110"/>
</div>

## 功能

- [x] 轮播
- [x] 搜索
- [x] 列表
- [x] 懒加载
- [x] 简单动画
- [x] loading
- [x] vue-router.ts
- [x] vuex.ts
- [x] vue-class-component使用
- [x] vuex-class使用
- [x] xxx.d.ts声明文件
- [x] 基于类的编写方式
- [x] mock数据
- [x] tsconfig.json
- [x] webpack配置
- [x] <b>vue-typescript-cli</b>

## 完成后的简单例子
基于类的写法加上静态类型检查，简直不能再嗨

```javascript
<script lang="ts">
import Vue from "vue";
import Component from "vue-class-component";
import { State } from "vuex-class";

@Component
export default class Shops extends Vue {
  @State shops: StoreState.shop[];
  @State searchVal: string;

  get shopList(): StoreState.shop[] {
    const shops = this.shops;
    const searchVal = this.searchVal;
    return shops.filter(
      (el: StoreState.shop) => el.shopName.indexOf(searchVal) > -1
    );
  }
}
</script>
```

# 为什么使用TypeScript

### 1. JavaScript的超集
支持所有原生JavaScript的语法
### 2. 强类型语言
现在很多主流语言都是强类型的，而这点也一直是JavaScript所被人诟病的地方。使用TypeScript之后，将会在代码调试、重构等步骤节省很多时间。

> 比如说：函数在返回值的时候可能经过复杂的操作，那我们如果想要知道这个值的结构就需要去仔细阅读这段代码。那如果有了TypeScript之后，直接就可以看到函数的返回值结构，将会非常的方便

### 3. 强大的IDE支持
现在的主流编辑器如`VSCode`、`WebStorm`、`Atom`、`Sublime`等都对TypeScript有着非常友好的支持，主要体现在智能提示上，非常的方便
### 4. 可运行于任何浏览器、计算机、操作系统
强大的编译引擎
### 5. 迭代更新快
不断更新，提供更加方便友好的Api
### 6. 微软和Google爸爸
TypeScript是微软开发的语言，而Google的`Angular`使用的就是TypeScript，所以不用担心会停止维护，至少在近几年内TypeScript都会一门主流开发语言
### 7. npm下载量非常高
截止2017.12.17, TypeScript在全球范围内的npm日均下载量在`30w`左右，这个数字将近是vue下载量的10倍，可见TypeScript还是非常受欢迎的

# Vue-TypeScript-Cli
官方虽然明确提出对TypeScript的支持，但是并没有明确的配置文档，自己在配置的时候还是需要查阅很多资料以及踩很多坑的（这个过程真的很蓝瘦-_-）

但是现在可以不用踩这个坑啦，我基于官方的`vue-cli`写了一个[vue-typescript-cli](https://github.com/SimonZhangITer/vue-typescript-template)，可以一键构建TypeScript模板

### 用法

```bash
vue init SimonZhangITer/vue-typescript-template <project-name>
```

比如

```bash
vue init SimonZhangITer/vue-typescript-template my-project
```
然后配置好的TypeScript模板就下载到`./my-project`文件夹了，`npm run dev`即可运行
# TypeScript配置
这里记录一下当时的踩坑过程，所有配置已经在[vue-typescript-template](https://github.com/SimonZhangITer/vue-typescript-template)配置完毕

## 1. Webpack

#### 安装ts-loader
首先需要安装`ts-loader`，这是TypeScript为Webpack提供的编译器，类似于`babel-loader`

```bash
npm i ts-loader -D
```

#### 配置rules
接着在Webpack的`module.rules`里面添加对ts的支持(我这里的webpack版本是2.x)：

```javascript
{
    test: /\.vue$/,
    loader: 'vue-loader',
    options: vueLoaderConfig
},
{
    test: /\.ts$/,
    loader: 'ts-loader',
    options: {
      appendTsSuffixTo: [/\.vue$/],
    }
}
```
#### 配置extensions
添加可识别文件后缀对ts的支持，如：

```javascript
extensions: ['.js', '.vue', '.json', '.ts']
```


## 2. tsconfig.json

创建tsconfig.json文件，放在根目录下，和`package.json`同级

配置内容主要也看个人需求，具体可以去typescript的官网查看，但是有一点需要注意：
> 在Vue中，你需要引入 strict: true (或者至少 noImplicitThis: true，这是 strict 模式的一部分) 以利用组件方法中 this 的类型检查，否则它会始终被看作 any 类型。

这里列出我的配置，功能在注释中给出

```javascript
{
  "include": [
    "src/*",
    "src/**/*"
  ],
  "exclude": [
    "node_modules"
  ],
  "compilerOptions": {
    // types option has been previously configured
    "types": [
      // add node as an option
      "node"
    ],
    // typeRoots option has been previously configured
    "typeRoots": [
      // add path to @types
      "node_modules/@types"
    ],
    // 以严格模式解析
    "strict": true,
    // 在.tsx文件里支持JSX
    "jsx": "preserve",
    // 使用的JSX工厂函数
    "jsxFactory": "h",
    // 允许从没有设置默认导出的模块中默认导入
    "allowSyntheticDefaultImports": true,
    // 启用装饰器
    "experimentalDecorators": true,
    "strictFunctionTypes": false,
    // 允许编译javascript文件
    "allowJs": true,
    // 采用的模块系统
    "module": "esnext",
    // 编译输出目标 ES 版本
    "target": "es5",
    // 如何处理模块
    "moduleResolution": "node",
    // 在表达式和声明上有隐含的any类型时报错
    "noImplicitAny": true,
    "lib": [
      "dom",
      "es5",
      "es6",
      "es7",
      "es2015.promise"
    ],
    "sourceMap": true,
    "pretty": true
  }
}
```

## 3. 修改main.js
1. 把项目主文件`main.js`修改成`main.ts`，里面的写法基本不变，但是有一点需要注意：
引入Vue文件的时候需要加上`.vue`后缀,否则编辑器识别不到

2. 把webpack的entry文件也修改成`main.ts`

## 4. vue-shims.d.ts
TypeScript并不支持Vue文件，所以需要告诉TypeScript`*.vue`文件交给vue编辑器来处理。解决方案就是在创建一个vue-shims.d.ts文件，建议放在src目录下再创建一个`typings`文件夹，把这个声明文件放进去，如：`src/typings/vue-shims.d.ts`，文件内容：

> `*.d.ts`类型文件不需要手动引入，TypeScript会自动加载

```javascript
declare module '*.vue' {
  import Vue from 'vue'
  export default Vue
}
```

到这里TypeScript在Vue中配置就完成了，可以愉快的撸代码了~

# 第三方插件库
现在Vue官方已经明确提出支持TypeScript，并考虑出一个对应的`vue-cli`，在这之前，Vue开发团队已经开发出了一些插件库来支持TypeScript，这里简单和大家介绍一下。

### Vue-Class-Component
[vue-class-component](https://github.com/vuejs/vue-class-component)是官方维护的TypeScript装饰器，写法比较扁平化。Vue对其做到完美兼容，如果你在声明组件时更喜欢基于类的 API，这个库一定不要错过

ps：用了这个装饰器之后写方法不需要额外加逗号，贼嗨~~~

```javascript
import Vue from "vue";
import Component from "vue-class-component";

@Component
export default class App extends Vue {
  name:string = 'Simon Zhang'

  // computed
  get MyName():string {
    return `My name is ${this.name}`
  }

  // methods
  sayHello():void {
    alert(`Hello ${this.name}`)
  }

  mounted() {
    this.sayHello();
  }
}
```
这个代码如果用原生Vue语法来写的话就是这样：

```javascript
export default {
  data () {
    return {
      name: 'Simon Zhang'
    }
  },

  mounted () {
    this.sayHello()
  },

  computed: {
    MyName() {
      return `My name is ${this.name}`
    }
  },

  methods: {
    sayHello() {
      alert(`Hello ${this.name}`)
    },
  }
}
```

### Vuex-Class
[vuex-class](https://github.com/ktsn/vuex-class)是基于基于`vue-class-component`对Vuex提供的装饰器。它的作者同时也是`vue-class-component`的主要贡献者，质量还是有保证的。

```javascript
import Vue from "vue";
import Component from "vue-class-component";
import { State, Action, Getter } from "vuex-class";

@Component
export default class App extends Vue {
  name:string = 'Simon Zhang'
  @State login: boolean;
  @Action initAjax: () => void;
  @Getter load: boolean;

  get isLogin(): boolean {
    return this.login;
  }

  mounted() {
    this.initAjax();
  }
}
```
上面的代码就相当于：

```javascript
export default {
  data() {
    return {
      name: 'Simon Zhang'
    }
  },

  mounted() {
    this.initAjax()
  },

  computed: {
    login() {
      return this.$store.state.login
    },
    load() {
      return this.$store.getters.load
    }
  },

  methods: {
    initAjax() {
      this.$store.dispatch('initAjax')
    }
  }
}
```

### Vue-Property-Decorator
[vue-property-decorator](https://github.com/kaorun343/vue-property-decorator) 是在 vue-class-component 上增强了更多的结合 Vue 特性的装饰器，新增了这 7 个装饰器

- `@Emit`
- `@Inject`
- `@Model`
- `@Prop`
- `@Provide`
- `@Watch`
- `@Component` (从 vue-class-component 继承)

# 坑
### 引入部分第三方库的时候需要额外声明文件
比如说我想引入`vue-lazyload`,虽然已经在本地安装，但是typescript还是提示找不到模块。原因是typescript是从`node_modules/@types`目录下去找模块声明，有些库并没有提供typescript的声明文件，所以就需要自己去添加

解决办法：在`src/typings`目前下建一个`tools.d.ts`文件，声明这个模块即可

```javascript
declare module 'vue-awesome-swiper' {
  export const swiper: any
  export const swiperSlide: any
}

declare module 'vue-lazyload'
```

### 对vuex的支持不是很好
在TypeScript里面使用不了mapState、mapGetters等方法，只能一个变量一个变量的去引用，这个要麻烦不少。不过使用`vuex-class`库之后，写法上也还算简洁美观

```javascript
export default class modules extends Vue {
  @State login: boolean; // 对应this.$store.state.login
  @State headline: StoreState.headline[]; // 对应this.$store.state.headline

  private swiperOption: Object = {
    autoplay: true,
    loop: true,
    direction: "vertical"
  };

  logoClick(): void {
    alert("点我干嘛");
  }
}
```

# 项目截图
<div align=center>
    <img src="https://p1.meituan.net/dpgroup/ffe7312edf899bdaa71e42ae2cff7293124895.png" width="266"/>
    <img src="https://p1.meituan.net/dpgroup/2ba7ac68cb3bcef937e48a9fcfb64ca7534292.png" width="266"/>
    <img src="http://opnxqffe4.bkt.clouddn.com/15135877156970.jpg" width="266"/>
</div>

# 总结
TypeScript还是非常值得学习和使用一个语言，还是有很多优点的

欢迎大家对我的项目提建议，欢迎Star~

QQ交流群：323743292
## Build Setup

``` bash
# 安装依赖
npm install

# 启动项目
npm run dev

# 打包项目
npm run build
```