TypeScript介绍-Nestjs框架-TypeORM框架

612 阅读31分钟

一、TypeScript基础与运用

1、TypeScript简介-中文文档

  • TypeScript是JavaScript的超集。
  • 它对JS进行了扩展,向JS中引入了类型的概念,并添加了许多新的特性。
  • TS代码需要通过编译器编译为JS,然后再交由JS解析器执行。
  • TS完全兼容JS,换言之,任何的JS代码都可以直接当成JS使用。
  • 相较于JS而言,TS拥有了静态类型,更加严格的语法,更强大的功能;
  • TS可以在代码执行前就完成代码的检查,减小了运行时异常的出现的几率;
  • TS代码可以编译为任意版本的JS代码,可有效解决不同JS运行环境的兼容问题;
  • 同样的功能,TS的代码量要大于JS,但由于TS的代码结构更加清晰,变量类型更加明确,在后期代码的维护中TS却远远胜于JS。

2、TypeScript 开发环境搭建

2.1 下载Node.js

2.2 安装Node.js

2.3 使用npm全局安装typescript

  • 进入命令行
  • 输入:npm i -g typescript

2.4 创建一个ts文件

使用tsc对ts文件进行编译

  • 进入命令行
  • 进入ts文件所在目录
  • 执行命令:tsc xxx.ts

3、基本类型

3.1 类型声明

  • 类型声明是TS非常重要的一个特点

  • 通过类型声明可以指定TS中变量(参数、形参)的类型

  • 指定类型后,当为变量赋值时,TS编译器会自动检查值是否符合类型声明,符合则赋值,否则报错

  • 简而言之,类型声明给变量设置了类型,使得变量只能存储某种类型的值

  • 语法:

 let 变量: 类型;
            ​
 let 变量: 类型 = 值;
            ​
 function fn(参数: 类型, 参数: 类型): 类型{
    ...
 }

3.2 自动类型判断

  • TS拥有自动的类型判断机制
  • 当对变量的声明和赋值是同时进行的,TS编译器会自动判断变量的类型
  • 所以如果你的变量的声明和赋值时同时进行的,可以省略掉类型声明

3.3 类型:

类型例子描述
number1, -33, 2.5任意数字
string'hi', "hi", hi任意字符串
booleantrue、false布尔值true或false
字面量其本身限制变量的值就是该字面量的值
any*任意类型
unknown*类型安全的any
void空值(undefined)没有值(或undefined)
never没有值不能是任何值
object{name:'孙悟空'}任意的JS对象
array[1,2,3]任意JS数组
tuple[4,5]元素,TS新增类型,固定长度数组
enumenum{A, B}枚举,TS中新增类型
  • number
let decimal: number = 6;
let hex: number = 0xf00d;
let binary: number = 0b1010;
let octal: number = 0o744;
let big: bigint = 100n;
  • boolean
let isDone: boolean = false;
  • string
let color: string = "blue";
color = 'red';
        ​
let fullName: string = `Bob Bobbington`;
let age: number = 37;
let sentence: string = `Hello, my name is ${fullName}.​I'll be ${age + 1} years old next month.`;
  • 字面量

也可以使用字面量去指定变量的类型,通过字面量可以确定变量的取值范围

let color: 'red' | 'blue' | 'black';
let num: 1 | 2 | 3 | 4 | 5;
  • any
let d: any = 4;
d = 'hello';
d = true;
  • unknown
let notSure: unknown = 4;
notSure = 'hello';
  • void
let unusable: void = undefined;
  • never
function error(message: string): never {
   throw new Error(message);
}
  • object(没啥用)
let obj: object = {};
  • array
let list: number[] = [1, 2, 3];
let list: Array<number> = [1, 2, 3];
  • tuple
let x: [string, number];
x = ["hello", 10]; 
  • enum
enum Color {
   Red,
   Green,
   Blue,
}
let c: Color = Color.Green;
enum Color {
   Red = 1,
   Green,
   Blue,
}
let c: Color = Color.Green;
enum Color {
   Red = 1,
   Green = 2,
   Blue = 4,
}
let c: Color = Color.Green;
  • 类型断言

有些情况下,变量的类型对于我们来说是很明确,但是TS编译器却并不清楚,此时,可以通过类型断言来告诉编译器变量的类型,断言有两种形式:

第一种:

let someValue: unknown = "this is a string";
let strLength: number = (someValue as string).length;

第二种:
let someValue: unknown = "this is a string";
let strLength: number = (<string>someValue).length;

3.4 编译选项

  • 自动编译文件

    • 编译文件时,使用 -w 指令后,TS编译器会自动监视文件的变化,并在文件发生变化时对文件进行重新编译。

    • 示例:

    tsc xxx.ts -w
    

3.5 自动编译整个项目

  • 如果直接使用tsc指令,则可以自动将当前项目下的所有ts文件编译为js文件。

  • 但是能直接使用tsc命令的前提时,要先在项目根目录下创建一个ts的配置文件 tsconfig.json

  • tsconfig.json是一个JSON文件,添加配置文件后,只需只需 tsc 命令即可完成对整个项目的编译

  • 配置选项:

    • include

      • 定义希望被编译文件所在的目录

      • 默认值:["**/*"]

      • 示例:

        • "include":["src/**/*", "tests/**/*"]
          
        • 上述示例中,所有src目录和tests目录下的文件都会被编译
    • exclude

      • 定义需要排除在外的目录

      • 默认值:["node_modules", "bower_components", "jspm_packages"]

      • 示例:

        • "exclude": ["./src/hello/**/*"]
          
        • 上述示例中,src下hello目录下的文件都不会被编译
    • extends

      • 定义被继承的配置文件

      • 示例:

        • "extends": "./configs/base"
          
        • 上述示例中,当前配置文件中会自动包含config目录下base.json中的所有配置信息
    • files

      • 指定被编译文件的列表,只有需要编译的文件少时才会用到

      • 示例:

        • "files": [
              "core.ts",
              "sys.ts",
              "types.ts",
              "scanner.ts",
              "parser.ts",
              "utilities.ts",
              "binder.ts",
              "checker.ts",
              "tsc.ts"
            ]
          
        • 列表中的文件都会被TS编译器所编译
    • compilerOptions

      • 编译选项是配置文件中非常重要也比较复杂的配置选项

      • 在compilerOptions中包含多个子选项,用来完成对编译的配置

      • 项目选项

        • target

        • 设置ts代码编译的目标版本

        • 可选值:

        ES3(默认)、ES5、ES6/ES2015、ES7/ES2016、ES2017、ES2018、ES2019、ES2020、ESNext

        • 示例:

               -   ```js
                   "compilerOptions": {
                       "target": "ES6"
                   }
                   ```
               -   如上设置,我们所编写的ts代码将会被编译为ES6版本的js代码
          
    • lib

      • 指定代码运行时所包含的库(宿主环境)

      • 可选值:

      ES5、ES6/ES2015、ES7/ES2016、ES2017、ES2018、ES2019、ES2020、ESNext、DOM、WebWorker、ScriptHost ......

      • 示例:
      "compilerOptions": {
         "target": "ES6",
         "lib": ["ES6", "DOM"],
         "outDir": "dist",
         "outFile": "dist/aa.js"
       }
      
    • module

      • 设置编译后代码使用的模块化系统

      • 可选值:

      CommonJS、UMD、AMD、System、ES2020、ESNext、None

      • 示例:
      "compilerOptions": {
         "module": "CommonJS"
      }
      
    • outDir

      • 编译后文件的所在目录

      • 默认情况下,编译后的js文件会和ts文件位于相同的目录,设置outDir后可以改变编译后文件的位置

      • 示例:

      "compilerOptions": {
          "outDir": "dist"
      }
      
      • 设置后编译后的js文件将会生成到dist目录
    • outFile

      • 将所有的文件编译为一个js文件

      • 示例:

      "compilerOptions": {
         "outFile": "dist/app.js"
       }
      
      • 默认会将所有的编写在全局作用域中的代码合并为一个js文件,如果module制定了None、System或AMD则会将模块一起合并到文件之中

    • rootDir

      • 指定代码的根目录,默认情况下编译后文件的目录结构会以最长的公共目录为根目录,通过rootDir可以手动指定根目录

      • 示例:

      "compilerOptions": {
        "rootDir": "./src"
      }
      
    • allowJs

      • 是否对js文件编译
    • checkJs

      • 是否对js文件进行检查

      • 示例:

      "compilerOptions": {
         "allowJs": true,
         "checkJs": true
      }
      
    • removeComments

      • 是否删除注释
      • 默认值:false
    • noEmit

      • 不对代码进行编译
      • 默认值:false
    • sourceMap

      • 是否生成sourceMap
      • 默认值:false
    • 严格检查

      • strict

      • 启用所有的严格检查,默认值为true,设置后相当于开启了所有的严格检查

    • alwaysStrict

      • 总是以严格模式对代码进行编译
    • noImplicitAny

      • 禁止隐式的any类型
    • noImplicitThis

      • 禁止类型不明确的this
    • strictBindCallApply

      • 严格检查bind、call和apply的参数列表
    • strictFunctionTypes

      • 严格检查函数的类型
    • strictNullChecks

      • 严格的空值检查
    • strictPropertyInitialization

      • 严格检查属性是否初始化
    • 额外检查

    • noFallthroughCasesInSwitch

      • 检查switch语句包含正确的break
    • noImplicitReturns

      • 检查函数没有隐式的返回值
    • noUnusedLocals

      • 检查未使用的局部变量
    • noUnusedParameters

      • 检查未使用的参数
    • 高级

    • allowUnreachableCode

      • 检查不可达代码
    • 可选值:

      • true,忽略不可达代码
      • false,不可达代码将引起错误
    • noEmitOnError

      • 有错误的情况下不进行编译
      • 默认值:false

4、webpack

  • 通常情况下,实际开发中我们都需要使用构建工具对代码进行打包,TS同样也可以结合构建工具一起使用,下边以webpack为例介绍一下如何结合构建工具使用TS。

  • 步骤:

    1. 初始化项目

      • 进入项目根目录,执行命令 npm init -y

        • 主要作用:创建package.json文件
    2. 下载构建工具

      • npm i -D webpack webpack-cli webpack-dev-server typescript ts-loader clean-webpack-plugin

        • 共安装了7个包

          • webpack

            • 构建工具webpack
          • webpack-cli

            • webpack的命令行工具
          • webpack-dev-server

            • webpack的开发服务器
          • typescript

            • ts编译器
          • ts-loader

            • ts加载器,用于在webpack中编译ts文件
          • html-webpack-plugin

            • webpack中html插件,用来自动创建html文件
          • clean-webpack-plugin

            • webpack中的清除插件,每次构建都会先清除目录
    3. 根目录下创建webpack的配置文件webpack.config.js

      • const path = require("path");
        const HtmlWebpackPlugin = require("html-webpack-plugin");
        const { CleanWebpackPlugin } = require("clean-webpack-plugin");
        ​
        module.exports = {
            optimization:{
                minimize: false // 关闭代码压缩,可选
            },
        ​
            entry: "./src/index.ts",
            
            devtool: "inline-source-map",
            
            devServer: {
                contentBase: './dist'
            },
        ​
            output: {
                path: path.resolve(__dirname, "dist"),
                filename: "bundle.js",
                environment: {
                    arrowFunction: false // 关闭webpack的箭头函数,可选
                }
            },
        ​
            resolve: {
                extensions: [".ts", ".js"]
            },
            
            module: {
                rules: [
                    {
                        test: /.ts$/,
                        use: {
                           loader: "ts-loader"     
                        },
                        exclude: /node_modules/
                    }
                ]
            },
        ​
            plugins: [
                new CleanWebpackPlugin(),
                new HtmlWebpackPlugin({
                    title:'TS测试'
                }),
            ]
        ​
        }
        
    4. 根目录下创建tsconfig.json,配置可以根据自己需要

      • {
            "compilerOptions": {
                "target": "ES2015",
                "module": "ES2015",
                "strict": true
            }
        }
        
    5. 修改package.json添加如下配置

      • {
          ...略...
          "scripts": {
            "test": "echo "Error: no test specified" && exit 1",
            "build": "webpack",
            "start": "webpack serve --open chrome.exe"
          },
          ...略...
        }
        
    6. 在src下创建ts文件,并在并命令行执行npm run build对代码进行编译,或者执行npm start来启动开发服务器

5、Babel

  • 经过一系列的配置,使得TS和webpack已经结合到了一起,除了webpack,开发中还经常需要结合babel来对代码进行转换以使其可以兼容到更多的浏览器,在上述步骤的基础上,通过以下步骤再将babel引入到项目中。

    1. 安装依赖包:

      • npm i -D @babel/core @babel/preset-env babel-loader core-js

      • 共安装了4个包,分别是:

        • @babel/core

          • babel的核心工具
        • @babel/preset-env

          • babel的预定义环境
        • @babel-loader

          • babel在webpack中的加载器
        • core-js

          • core-js用来使老版本的浏览器支持新版ES语法
    2. 修改webpack.config.js配置文件

      • ...略...
        module: {
            rules: [
                {
                    test: /.ts$/,
                    use: [
                        {
                            loader: "babel-loader",
                            options:{
                                presets: [
                                    [
                                        "@babel/preset-env",
                                        {
                                            "targets":{
                                                "chrome": "58",
                                                "ie": "11"
                                            },
                                            "corejs":"3",
                                            "useBuiltIns": "usage"
                                        }
                                    ]
                                ]
                            }
                        },
                        {
                            loader: "ts-loader",
        ​
                        }
                    ],
                    exclude: /node_modules/
                }
            ]
        }
        ...略...
        
      • 如此一来,使用ts编译后的文件将会再次被babel处理,使得代码可以在大部分浏览器中直接使用,可以在配置选项的targets中指定要兼容的浏览器版本。

6、面向对象

面向对象是程序中一个非常重要的思想,它被很多同学理解成了一个比较难,比较深奥的问题,其实不然。面向对象很简单,简而言之就是程序之中所有的操作都需要通过对象来完成。

  • 举例来说:

    • 操作浏览器要使用window对象
    • 操作网页要使用document对象
    • 操作控制台要使用console对象

一切操作都要通过对象,也就是所谓的面向对象,那么对象到底是什么呢?这就要先说到程序是什么,计算机程序的本质就是对现实事物的抽象,抽象的反义词是具体,比如:照片是对一个具体的人的抽象,汽车模型是对具体汽车的抽象等等。程序也是对事物的抽象,在程序中我们可以表示一个人、一条狗、一把枪、一颗子弹等等所有的事物。一个事物到了程序中就变成了一个对象。

在程序中所有的对象都被分成了两个部分数据和功能,以人为例,人的姓名、性别、年龄、身高、体重等属于数据,人可以说话、走路、吃饭、睡觉这些属于人的功能。数据在对象中被成为属性,而功能就被称为方法。所以简而言之,在程序中一切皆是对象。

6.1 类(class)

要想面向对象,操作对象,首先便要拥有对象,那么下一个问题就是如何创建对象。要创建对象,必须要先定义类,所谓的类可以理解为对象的模型,程序中可以根据类创建指定类型的对象,举例来说:可以通过Person类来创建人的对象,通过Dog类创建狗的对象,通过Car类来创建汽车的对象,不同的类可以用来创建不同的对象。

  • 定义类:
        class 类名 {
            属性名: 类型;
            
            constructor(参数: 类型){
                this.属性名 = 参数;
            }
            
            方法名(){
                ....
            }
        ​
        }
  • 示例:
       class Person{
           name: string;
           age: number;
       ​
           constructor(name: string, age: number){
               this.name = name;
               this.age = age;
           }
       ​
           sayHello(){
               console.log(`大家好,我是${this.name}`);
           }
       }
  • 使用类:
        const p = new Person('孙悟空', 18);
        p.sayHello();

6.2 面向对象的特点

  • 封装

    • 对象实质上就是属性和方法的容器,它的主要作用就是存储属性和方法,这就是所谓的封装

    • 默认情况下,对象的属性是可以任意的修改的,为了确保数据的安全性,在TS中可以对属性的权限进行设置

    • 只读属性(readonly):

      • 如果在声明属性时添加一个readonly,则属性便成了只读属性无法修改
    • TS中属性具有三种修饰符:

      • public(默认值),可以在类、子类和对象中修改
      • protected ,可以在类、子类中修改
      • private ,可以在类中修改
    • 示例:

      • public
              class Person{
                  public name: string; // 写或什么都不写都是public
                  public age: number;
              ​
                  constructor(name: string, age: number){
                      this.name = name; // 可以在类中修改
                      this.age = age;
                  }
              ​
                  sayHello(){
                      console.log(`大家好,我是${this.name}`);
                  }
              }
              ​
              class Employee extends Person{
                  constructor(name: string, age: number){
                      super(name, age);
                      this.name = name; //子类中可以修改
                  }
              }
              ​
              const p = new Person('孙悟空', 18);
              p.name = '猪八戒';// 可以通过对象修改
      
      • protected
              class Person{
                  protected name: string;
                  protected age: number;
              ​
                  constructor(name: string, age: number){
                      this.name = name; // 可以修改
                      this.age = age;
                  }
              ​
                  sayHello(){
                      console.log(`大家好,我是${this.name}`);
                  }
              }
              ​
              class Employee extends Person{
              ​
                  constructor(name: string, age: number){
                      super(name, age);
                      this.name = name; //子类中可以修改
                  }
              }
              ​
              const p = new Person('孙悟空', 18);
              p.name = '猪八戒';// 不能修改
      
      • private
              class Person{
                  private name: string;
                  private age: number;
              ​
                  constructor(name: string, age: number){
                      this.name = name; // 可以修改
                      this.age = age;
                  }
              ​
                  sayHello(){
                      console.log(`大家好,我是${this.name}`);
                  }
              }
              ​
              class Employee extends Person{
              ​
                  constructor(name: string, age: number){
                      super(name, age);
                      this.name = name; //子类中不能修改
                  }
              }
              ​
              const p = new Person('孙悟空', 18);
              p.name = '猪八戒';// 不能修改
      
    • 属性存取器

      • 对于一些不希望被任意修改的属性,可以将其设置为private

      • 直接将其设置为private将导致无法再通过对象修改其中的属性

      • 我们可以在类中定义一组读取、设置属性的方法,这种对属性读取或设置的属性被称为属性的存取器

      • 读取属性的方法叫做setter方法,设置属性的方法叫做getter方法

      • 示例:

              class Person{
                  private _name: string;
              ​
                  constructor(name: string){
                      this._name = name;
                  }
              ​
                  get name(){
                      return this._name;
                  }
              ​
                  set name(name: string){
                      this._name = name;
                  }
              ​
              }
              ​
              const p1 = new Person('孙悟空');
              console.log(p1.name); // 通过getter读取name属性
              p1.name = '猪八戒'; // 通过setter修改name属性
      
    • 静态属性

      • 静态属性(方法),也称为类属性。使用静态属性无需创建实例,通过类即可直接使用

      • 静态属性(方法)使用static开头

      • 示例:

              class Tools{
                  static PI = 3.1415926;
                  
                  static sum(num1: number, num2: number){
                      return num1 + num2
                  }
              }
              ​
              console.log(Tools.PI);
              console.log(Tools.sum(123, 456));
      
    • this

      • 在类中,使用this表示当前对象
  • 继承

    • 继承时面向对象中的又一个特性

    • 通过继承可以将其他类中的属性和方法引入到当前类中

      • 示例:
              class Animal{
                  name: string;
                  age: number;
      
                  constructor(name: string, age: number){
                      this.name = name;
                      this.age = age;
                  }
              }
      
              class Dog extends Animal{
      
                  bark(){
                      console.log(`${this.name}在汪汪叫!`);
                  }
              }
      
              const dog = new Dog('旺财', 4);
              dog.bark();
      
    • 通过继承可以在不修改类的情况下完成对类的扩展

    • 重写

      • 发生继承时,如果子类中的方法会替换掉父类中的同名方法,这就称为方法的重写

      • 示例:

              class Animal{
                  name: string;
                  age: number;
              ​
                  constructor(name: string, age: number){
                      this.name = name;
                      this.age = age;
                  }
              ​
                  run(){
                      console.log(`父类中的run方法!`);
                  }
              }
              ​
              class Dog extends Animal{
              ​
                  bark(){
                      console.log(`${this.name}在汪汪叫!`);
                  }
              ​
                  run(){
                      console.log(`子类中的run方法,会重写父类中的run方法!`);
                  }
              }
              ​
              const dog = new Dog('旺财', 4);
              dog.bark();
      
      • 在子类中可以使用super来完成对父类的引用
    • 抽象类(abstract class)

      • 抽象类是专门用来被其他类所继承的类,它只能被其他类所继承不能用来创建实例
          abstract class Animal{
              abstract run(): void;
              bark(){
                  console.log('动物在叫~');
              }
          }
          ​
          class Dog extends Animals{
              run(){
                  console.log('狗在跑~');
              }
          }
      
      • 使用abstract开头的方法叫做抽象方法,抽象方法没有方法体只能定义在抽象类中,继承抽象类时抽象方法必须要实现

6.3 接口(Interface)

接口的作用类似于抽象类,不同点在于接口中的所有方法和属性都是没有实值的,换句话说接口中的所有方法都是抽象方法。接口主要负责定义一个类的结构,接口可以去限制一个对象的接口,对象只有包含接口中定义的所有属性和方法时才能匹配接口。同时,可以让一个类去实现接口,实现接口时类中要保护接口中的所有属性。

  • 示例(检查对象类型):
        interface Person{
            name: string;
            sayHello():void;
        }
        ​
        function fn(per: Person){
            per.sayHello();
        }
        ​
        fn({name:'孙悟空', sayHello() {console.log(`Hello, 我是 ${this.name}`)}});
        ​
  • 示例(实现)
        interface Person{
            name: string;
            sayHello():void;
        }
        ​
        class Student implements Person{
            constructor(public name: string) {
            }
        ​
            sayHello() {
                console.log('大家好,我是'+this.name);
            }
        }

6.4 泛型(Generic)

定义一个函数或类时,有些情况下无法确定其中要使用的具体类型(返回值、参数、属性的类型不能确定),此时泛型便能够发挥作用。

  • 举个例子:
        function test(arg: any): any{
            return arg;
        }

上例中,test函数有一个参数类型不确定,但是能确定的时其返回值的类型和参数的类型是相同的,由于类型不确定所以参数和返回值均使用了any,但是很明显这样做是不合适的,首先使用any会关闭TS的类型检查,其次这样设置也不能体现出参数和返回值是相同的类型

  • 使用泛型:
        function test<T>(arg: T): T{
            return arg;
        }
  • 这里的<T>就是泛型,T是我们给这个类型起的名字(不一定非叫T),设置泛型后即可在函数中使用T来表示该类型。所以泛型其实很好理解,就表示某个类型。

    • 那么如何使用上边的函数呢?

      • 方式一(直接使用):

        • test(10)
          
        • 使用时可以直接传递参数使用,类型会由TS自动推断出来,但有时编译器无法自动推断时还需要使用下面的方式
      • 方式二(指定类型):

        • test<number>(10)
          
        • 也可以在函数后手动指定泛型
    • 可以同时指定多个泛型,泛型间使用逗号隔开:

            function test<T, K>(a: T, b: K): K{
                return b;
            }
            ​
            test<number, string>(10, "hello");
    
    • 使用泛型时,完全可以将泛型当成是一个普通的类去使用

    • 类中同样可以使用泛型:

            class MyClass<T>{
                prop: T;
            ​
                constructor(prop: T){
                    this.prop = prop;
                }
            }
    
    • 除此之外,也可以对泛型的范围进行约束
            interface MyInter{
                length: number;
            }
            ​
            function test<T extends MyInter>(arg: T): number{
                return arg.length;
            }
    
    • 使用T extends MyInter表示泛型T必须是MyInter的子类,不一定非要使用接口类和抽象类同样适用。

7、深入理解ES6中class的this指向

在ES6中,引入了类似其他语言的类的写法:即class(类),作为类对象模板。
ES6 的class可以看作一个语法糖,它的绝大部分功能ES5 都可以做到。
新的class写法只是让对象原型的写法更加清晰、更像面向对象编程的语法而已。

7.1 class的基本语法

基本语法:class name [extends] { // class body }
在下面的例子中,有两处的this:

  • constructor里的this.x = x和this.y = y
    在class的构造函数constructor内部中的环境,表示的是对象生效时的执行环境,而此时的this指向的就是该执行环境。
    而对象生效的时候,是对象在实例化的过程(myDemo = new Demo(2, 3)),所以这里的this是指向对象的实例myDemo。
  • sum函数里的let sumVal = this.x + this.y
    这里的this实际指向的是sum执行时的执行环境。
    当以myDemo.sum()的方式运行时,其实是this的隐式绑定,当前tsum函数里的this实际上是指向myDemo实例。所以this能找到x和y,能够得到正确的结果。
"use strict";

class Demo {
    constructor(x, y) {
        this.x = x;
        this.y = y;
    }
    sum() {
        let sumVal = this.x + this.y;
        return sumVal;
    }
}

let myDemo = new Demo(2, 3);
console.log(myDemo.sum()); // 5

7.2 class中使用this的指向深入理解

对上述中的例子进行适当改造,将对象里面的方法sum作为对象赋值给新变量,然后调用新变量。
此处主要改变了class中sum的调用位置:首先将myDemo.sum的引用赋值给新的变量sum,然后再调用该方法sum()。
实际上,class里的sum是一个对象内容,而myDemo.sum只是指向该sum的一个变量。而将myDemo.sum赋值给新变量sum,只是让新变量指向class的sum,新变量sum与myDemo.sum本身没有关系。

"use strict";

class Demo {
    constructor(x, y) {
    this.x = x;
    this.y = y;
    }
    sum() {
        let sumVal = this.x + this.y;
        return sumVal;
    }
}

let myDemo = new Demo(2, 3);
const sum = myDemo.sum; //将sum的引用赋值给新变量sum (写法等同于 const { sum } = myDemo;)
sum();// Uncaught TypeError: Cannot read property 'x' of undefined

sum函数里的this,会根据是否是严格模式而指向undefined或者全局环境
尽管在全局环境里执行sum(),因为是在严格模式下,所以这里的this指向的是undefined,而undefined没有属性x和y, 导致找不到该属性而抛出TypeError。\

注:ES6 的class内部默认为严格模式

解决this指向环境方法

  • 在对象实例化时将sum中的this绑定到实例化对象中
    当对象实例化时:let myDemo = new Demo(2, 3);,就将sum的this显式绑定到实例的this。
    而单独调用sum函数的时候,相当于是默认绑定。
    默认绑定优先级 < 显式绑定优先级,所以就算单独运行sum函数,那么class的sum中this还是指向对应的实例化对象。
class Demo {
    constructor(x, y) {
    this.x = x;
    this.y = y;
    this.sum = this.sum.bind(this); // sum中this显式绑定
    }
    sum() {
        let sumVal = this.x + this.y;
        return sumVal;
    }
}

let myDemo = new Demo(2, 3);
const sum = myDemo.sum; 
sum(); // 5

  • 使用箭头函数
    ES6引入了箭头函数,箭头函数不仅简化了函数的缩写,另外一个很重要的特点是:箭头函数不会创建自己的this值,它的this值是继承外层作用域链上的this

7.3 小结

实际上,决定this的指向,是需要看它被调用的位置,而不是它被写入的位置。
同时,需要考虑到调用顺序:

是否是new binding, const bar = new Foo()
是否是显示绑定,比如call,apply,bind, const bar = foo.call(obj2)
是否是隐式绑定,比如函数调用, const bar = obj1.foo()
最后是默认绑定,在严格模式下,thisundefined,否则是全局对象, 比如:const bar = foo()

隐式绑定丢失问题

function foo() {
    console.log( this.a );
}

var obj = {
    a: 2,
    foo: foo
};

var bar = obj.foo; // function reference/alias!

var a = "oops, global"; // `a` also property on global object

bar(); // "oops, global"

函数作为回调参数传递也有类似问题:

function foo() {
    console.log( this.a );
}

function doFoo(fn) {
    fn(); 
}

var obj = {
    a: 2,
    foo: foo
};

var a = "oops, global";

doFoo( obj.foo ); // "oops, global"

定时函数执行也存在相同问题:

function foo() {
    console.log( this.a );
}

var obj = {
    a: 2,
    foo: foo
};

var a = "oops, global"; // `a` also property on global object

setTimeout( obj.foo, 100 ); // "oops, global"

二、Nestjs

1、概念

Nest 是一个用于构建高效,可扩展的 Node.js 服务器端应用程序的框架。它使用渐进式 JavaScript,内置并完全支持 TypeScript(但仍然允许开发人员使用纯 JavaScript 编写代码)并结合了 OOP(面向对象编程),FP(函数式编程)和 FRP(函数式响应编程)的元素。

在底层,Nest使用强大的 HTTP Server 框架,如 Express(默认)和 Fastify。Nest 在这些框架之上提供了一定程度的抽象,同时也将其 API 直接暴露给开发人员。设计上很多灵感来自于 Angular 或者后端常用的Java技术栈 Spring 框架,如依赖注入、面向切面编程(AOP)等,可以说 Nest 是 Node.js 版的 Spring 框架。

  • Nestjs的优点

    • 支持 TypeScript,使语法更加规范
    • 兼容 Express 中间件,Express 是最早出现的轻量级的 node server端框架
    • 层层处理,可以约束代码,比如何时使用中间件、使用 Guards守卫 等
    • 依赖注入及模块化的思想,提供了完整的 MVC 链路,使代码结构清晰,便于维护
  • 支持使用脚手架 CLI 来生成项目架构


// 安装Nest CLI
$ npm i -g @nestjs/cli
// 使用nest cli 构建项目
$ nest new project-name
// 启动程序
$ npm run start

  • 核心文件介绍

image.png

2、应用

从客户端发送一个post请求,路径为:/user/login,请求参数为:{userinfo: ‘xx’,password: ‘xx’},到服务器接收请求内容,触发绑定的函数并且执行相关逻辑完毕,然后返回内容给客户端的整个过程大体上要经过如下几个步骤:

image.png

2.1 控制器 Controller

控制器负责处理传入的请求并将响应返回给客户端。
控制器的目的是接收应用程序的特定请求。在路由该控制器接收用于请求机构的控制。通常,每个控制器具有多个路由,并且不同的路由可以执行不同的动作。

为了创建一个基本的控制器,我们使用类和装饰器。装饰器将类与所需的元数据相关联,并使Nest能够创建路由映射(将请求绑定到相应的控制器)。

在下面的示例中,我们将使用定义基本控制器所需的 @Controller()装饰器。我们将指定一个可选的前缀。在Controller装饰器中使用前缀允许我们避免在路径可能共享公共前缀时重复自己

  • 控制器原理

    • 控制器 —— 接收应用的特定请求
    • 路由机制 —— 控制哪个控制器接收哪些请求
    • 控制器及路由的关系 —— 一个控制器有多个路由,不同路由 执行 不同操作

image.png

import { Controller, Get } from '@nestjs/common';
import { AppService } from './app.service';

@Controller()
export class AppController {
  constructor(private readonly appService: AppService) {}

  @Get()
  getHello(): string {
    return this.appService.getHello();
  }
}

  • 装饰器简单定义

ES2016 的装饰器是一个可以将目标对象,名称和属性描述符作为被修饰方法(returns function)的参数的表达式。你可以通过装饰器前缀 @ 来使用它,并且把它放在你试图装饰的最上面。装饰器可以被定义为一个类或是属性。

2.2 提供者 Provider

几乎所有的东西都可以被认为是提供者(例如:service, repository, factory, helper...),提供者的本质:用 @Injectable() 装饰器 注解的简单类

提供者 Provider 可以通过 constructor 注入依赖关系(即创建各种关系)

  • 【控制反转】是面向对象编程中的一种 设计原则,用来降低代码耦合度

通过控制反转,对象在被创建的时候,有一个调控系统内所有对象的外界实体,将其所依赖的对象的引用传递给它

也可以说,通过控制反转,依赖被注入到对象

  • 【依赖注入】 把有依赖关系的类放到容器中,解析出这些类的实例,进而实现类的解耦

举个栗子:Class A 中用到了 Class B 的对象 b,一般情况下,需要在 A 的代码中显式的 new 一个 B 的对象。采用依赖注入技术之后,A 的代码只需要定义一个私有的 B 对象,不需要直接 new 来获得这个对象,而是通过相关的容器控制程序来将 B 对象在外部 new 出来并注入到 A 类里的引用中

  • 【控制反转和依赖注入的关系】

    • 依赖注入(Dependency Injection,简称 DI)
    • 控制反转(Inversion of Control,简称 IoC)

DI 是实现 IoC 的一种常见方式

举个栗子(摘抄):假设你是一个想开公司的富二代,开公司首先需要一间办公室。那么你不用自己去买,你只需要在你的清单列表上写上办公室这么一项,那么,你老爸已经派人给你安排好了办公室,这间办公室长什么样?多大?在哪里?是租的?还是买的?你根本不知道,你也不需要知道。 现在你又在清单上写了需要 80 台办公电脑,你老爸又给你安排好了 80 台, 你自己并不需要关心这些电脑是什么配置,买什么样的 CPU 性价比更高,只要他们是能办公的电脑就行了。 这里你的老爸就是所谓的 IoC 容器,你在编写 Company 这个 Class 的时候,你内部用到的 Office、Computers 对象不需要你自己导入和实例化,你只需要在 Company 这个类的 Constructor (构造函数) 中声明你需要的对象,IoC 容器会帮你把所依赖的对象实例注入进去。

Nest 就是建立在 依赖注入 这种设计模式之上的

它在框架内部封装了一个 IoC 容器来管理所有的依赖关系

import { Injectable } from '@nestjs/common';

@Injectable()
export class AppService {
  getHello(): string {
    return 'Hello World!';
  }
}

2.3 模块 Module

模块是用 @Module() 装饰器 注解的简单类

@Module() 装饰器提供了 元数据,Nest 用它来 组织应用程序结构

image.png

每个 Nest 应用程序至少有一个模块 —— 根模块

当应用很小时,根模块可能是应用程序中唯一的模块 当应用很大时,应用将会拥有多个模块,每个模块都有一组紧密相关的功能 模块的好处:业务低耦合、边界清晰、便于排查错误、便于维护

@module() 装饰器接受一个 描述模块属性的对象

import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';

@Module({
  imports: [],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

  • providers:服务提供者列表,本模块可用,会自动注入
  • controllers:控制器列表,本模块可用,会绑定路由访问
  • imports:本模块导入的模块,如需要使用其他模块的 provider,则必须导入其他模块
  • exports:本模块导出的服务提供者,在此处定义的 provider 才能被其他模块使用

2.4 中间件 Middleware

  • 中间件的作用
    • 执行任何代码
    • 更改请求/响应对象
    • 结束请求-响应周期
    • 调用堆栈中的下一个中间件函数
    • 如果当前的中间件函数没有结束请求-响应周期,那么必须调用next()将控制权传递给下一个中间件函数。否则请求会一直停留在挂起状态。

中间件 —— 客户端 和 路由处理 的中间,在路由处理程序之前,调用的 函数

中间件函数可以访问:请求对象、响应对象、请求响应周期中的 next() 中间件函数

next() 中间件函数,通常由名为 next 的变量表示,他决定了请求-响应的循环系统

image.png

Nest 中间件,可以是一个函数,也可以是一个带有 @Injectable() 装饰器的类

2.5 异常过滤器 Filter

当项目中出现了异常,而代码中却没有处理,那么这个异常就会到 Nest.js 内建的异常处理层,它能将异常更友好地响应给前端。

image.png

  • 内置的HttpException

Exception filters机制是开箱即用的,此操作由内置的全局异常过滤器执行,该过滤器处理HttpException类(及其子类)的异常。如果无法识别异常(既不是HttpException也不是从HttpException继承的类),则内置异常过滤器将生成以下默认JSON响应:

{
    "statusCode": 500,
    "message": "Internal server error"
}

可以随意使用内置的HttpException捕获:

@Get()
async findAll() {
  throw new HttpException('Forbidden', HttpStatus.FORBIDDEN);
}

这样的话客户端会收到这样的响应:

{
  "statusCode": 403,
  "message": "Forbidden"
}

要仅覆盖JSON响应主体的消息部分,我们只需要在response参数中提供一个字符串。 要覆盖整个JSON响应主体,我可以在response参数中传递一个对象。比如:

@Get()
async findAll() {
  throw new HttpException({
    status: HttpStatus.FORBIDDEN,
    error: 'This is a custom message',
  }, HttpStatus.FORBIDDEN);
}

这样的话,响应就是下面的样子了:

{
  "status": 403,
  "error": "This is a custom message"
}

2.6 管道 Pipe

  • 管道本质:一个实现了 PipeTransform 接口,并用 @Injectable() 装饰器 修饰的类

  • 管道作用:

    • 转换:将输入数据转换为所需的格式输出
    • 验证:验证输入的内容是否满足预先定义的规则,当数据不正确时可能会抛出异常

举个栗子:把参数转化成十进制的整型数字 的管道 ParseIntPipe

// 注意下方 使用的装饰器 @Injectable() 及 实现的接口 PipeTransform
@Injectable()
export class ParseIntPipe implements PipeTransform<string, number> {
  transform(value: string, metadata: ArgumentMetadata): number {
    const val = parseInt(value, 10);
    if (isNaN(val)) {
      throw new BadRequestException("Validation failed");
    }
    return val;
  }
}

对于 get 请求中的参数 id,调用 new ParseIntPipe 将 参数 id 转化成十进制的整数

@Get(':id')
async findOne(@Param('id', new ParseIntPipe()) id) {
  return await this.catsService.findOne(id);
}

2.7 守卫 Guard

守卫:实现权限验证,比如验证请求是否包含 token 或者 token 是否过期

与 中间件 Middleware 相比,守卫 Guard 能获得更详细的关于请求的执行上下文信息

通常 Guards,位于 Middleware 之后,Pipe 之前(请求正式被处理函数处理之前)

import { Injectable, CanActivate, ExecutionContext } from "@nestjs/common";
import { Observable } from "rxjs";
 
@Injectable()
export class AuthGuard implements CanActivate {
  canActivate(
    context: ExecutionContext
  ): boolean | Promise<boolean> | Observable<boolean> {
    const request = context.switchToHttp().getRequest();
    return validateRequest(request);
  }
}
export interface ArgumentsHost {
  getArgs<T extends Array<any> = any[]>(): T;
  getArgByIndex<T = any>(index: number): T;
  switchToRpc(): RpcArgumentsHost;
  switchToHttp(): HttpArgumentsHost;
  switchToWs(): WsArgumentsHost;
}
export interface ExecutionContext extends ArgumentsHost {
  getClass<T = any>(): Type<T>;
  getHandler(): Function;
}

Guards是单一职责的。它们根据运行时出现的某些条件(例如权限,角色,ACL等)来确定给定的请求是否由路由处理程序处理。这通常称为授权。授权(以及它通常与之合作的东西——身份验证)通常由传统Express应用中的中间件处理。中间件是身份验证的不错选择,因为像令牌验证,或者向请求对象上添加属性等这样的事情,与路由之间没有强烈的关联。

但是,中间件有些其他问题。在调用next()函数后,它不知道哪个处理程序会被执行。而Guards可以访问ExecutionContext实例,因此确切知道下一步将要执行什么。它们的设计非常类似于异常过滤器,管道和拦截器,使您可以在请求/响应周期中的正确位置插入处理逻辑。

Guards在中间件之后,拦截器/管道之前执行。

image.png

2.8 拦截器 Interceptor

拦截器本质:一个实现了 NestInterceptor 接口,并用 @Injectable() 装饰器 修饰的类

  • 拦截器作用:

    • 在方法执行之前/之后加入我们自己的逻辑
    • 转换/包装一个方法返回的结果
    • 转换/包装一个方法抛出的异常
    • 扩展基础方法的内容
    • 根据某些特殊情况(比如缓存的目的)完全覆盖/重写一个方法

举个栗子:对所有接口返回的 数据结构 处理(应用拦截器的)

2.9 装饰器

ES2016 的装饰器是一个可以将目标对象,名称和属性描述符作为被修饰方法(returns function)的参数的表达式。你可以通过装饰器前缀 @ 来使用它,并且把它放在你试图装饰的最上面。装饰器可以被定义为一个类或是属性。

装饰器 —— 一种特殊类型的声明,本质上就是一个 方法

装饰器可以注入到类、类的方法、类的属性、类的参数上,用于扩展功能

  • 装饰器的分类:

    • 类的装饰器
    • 类方法的装饰器
    • 类函数参数的装饰器
    • 类的属性的装饰器

举个栗子:项目代码 main.ts 页面(应用装饰器)

2.10 AOP(Aspect Oriented Programming)

面向切面编程 —— 通过 预编译方式 和 运行期间动态代理 实现程序功能的统一维护的一种技术(在运行时,动态地将代码切入到类的指定方法、指定位置上)

切入点:指定类/指定方法 切入到的 代码片段 称为切面,切入到哪些类、哪些方法

AOP 可以把几个类共有的代码,抽取到一个切片中,等到需要时再切入对象中去,从而改变其原有的行为

  • AOP 优点:

    • 降低业务逻辑各部分之间的耦合度
    • 提高程序的可重用性
    • 提高了开发的效率
    • 提高代码的灵活性和可扩展性
    • 将日志记录,性能统计,安全控制,事务处理,异常处理等代码从业务逻辑代码中划分出来

通过对这些行为的分离,将它们独立到非指导业务逻辑的方法中,进而实现改变这些行为时,不影响业务逻辑的代码

3、Nest.js 内部层级关系

image.png

4、对象属性中的特性值 vs 装饰器

ES5 中,对象中的每个属性都有 特性值 来描述这个属性的特点,他们分别是:

  • configurable:属性是否能被 delete 删除,当值为 false 时,其他特性值也不能被改变,默认值为 true

  • enumerable:属性是否能被枚举,也就是是否能被 for in 循环遍历,默认为 true

  • writable:属性值是否能修改,默认为 true

  • value:属性值具体是多少,默认为 undefined

  • get:当通过 person.name 访问 name 的属性值时,get() 将被调用,get() 可以自定义返回的具体值是多少,get 默认值为 undefined

  • set:当通过 person.name = 'Jake' 设置 name 的属性值时,set() 将被调用,set() 可以自定义设置值的具体方式,set 默认值为 undefined

注意:不能同时设置value、writeable 与 get、set

可以通过 Object.defineProperty(操作单个) 与 Object.defineProperties(操作多个) 来修改这些特性值

上述方法的参数:

  • target(对象)
  • key(对象属性)
  • descriptor(对象属性的 特性值的 描述对象)
var person = {
  name: "Lily",
};
 
// 修改
Object.defineProperty(person, "name", {
  value: "Lucy",
});
 
// 新增
Object.defineProperty(person, "age", {
  value: 20,
});

下面写一个装饰器函数 nameDecorator()

函数 nameDecorator(),会重写被他装饰的属性,函数最后必须返回 descriptor

function nameDecorator(target, key, descriptor) {
  descriptor.value = () => {
    return "Tom";
  };
  return descriptor;
}

@nameDecorator,就是装饰器语法

自定义函数 nameDecorator 的参数中,target(被装饰的对象Person),key(被装饰的具体方法 getName())

getName() 方法的三个参数,与 Object.defineProperty 一一对应,分别指当前的对象Person,被作用的属性 getName(),以及属性特性值的描述对象 descriptor

函数 nameDecorator(),会重写被他装饰的属性 getName()

class Person {
  constructor() {
    this.name = "Lily";
  }
  @nameDecorator
  getName() {
    return this.name;
  }
}
 
let p1 = new Person();
console.log(p1.getName());

三、TypeORM介绍与运用(mySql)

1、概念

1.1 官方文档

TypeORM 是一个ORM框架,它可以运行在 NodeJS、Browser、Cordova、PhoneGap、Ionic、React Native、Expo 和 Electron 平台上,可以与 TypeScript 和 JavaScript (ES5,ES6,ES7,ES8)一起使用。 它的目标是始终支持最新的 JavaScript 特性并提供额外的特性以帮助你开发任何使用数据库的(不管是只有几张表的小型应用还是拥有多数据库的大型企业应用)应用程序。

不同于现有的所有其他 JavaScript ORM 框架,TypeORM 支持 Active Record 和 Data Mapper 模式,这意味着你可以以最高效的方式编写高质量的、松耦合的、可扩展的、可维护的应用程序。

TypeORM 参考了很多其他优秀 ORM 的实现, 比如 HibernateDoctrine和 Entity Framework

2、mySql实现数据持久化

2.1 安装依赖

使用 TypeORM 和 mysql 需要在项目中安装以下包

npm install --save @nestjs/typeorm typeorm mysql2

2.2 引用配置

首先我们在 app.module 中引用 TypeOrmModuleTypeOrmModule@nestjs/typeorm 提供

// src/app.modules.ts

import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { ArticleModule } from './modules/article/article.module';
import { TypeOrmModule } from '@nestjs/typeorm'
@Module({
  imports: [
    // 使用 TypeORM 配置数据库
    TypeOrmModule.forRoot({
      type: 'mysql',
      host: 'localhost',
      port: 3306,
      username: 'root',
      password: '888888',
      database: 'test',
      entities: ["dist/modules/**/*.entity{.ts,.js}"],
      synchronize: true,
    }),
    ArticleModule
  ],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

我们在此示例中使用 MySQL,你可以使用任何其他受支持的数据库。要使用其他数据库,只需将选项中的type更改为希望使用的数据库类型:mysql,mariadb,postgres,sqlite,mssql,oracle,cordova,nativescript,react-native,expo 或 mongodb。同时还要确保 host, port, username, password 和数据库设置的正确性。

设置synchronize可确保每次运行应用程序时实体都将与数据库同步。

// 配置文件
{
  "type": "mysql", // 选用的数据库
  "host": "localhost", // 数据库地址
  "port": 3306, // 数据库端口
  "username": "test", // 数据库用户名
  "password": "test", // 数据库密码
  "database": "test", // 数据库
  "synchronize": true, // 是否同步true表示会自动将src/entity里面定义的数据模块同步到数据库生成数据表(已经存在的表的时候再运行会报错)
  "dropSchema": true, // 删除数据库中的表
  "logging": false, // 是否打印日志,执行sql语句时候输出原生sql,也可以配置成一个数组["query", "error", "schema"]指定sql的执行类型
  "charset": "utf8mb4", // 编码
  "timezone": "local", // 时区,默认本地,也可以写"+8"
  "entityPrefix": "", // 给此数据库连接上的所有表(或集合)加的前缀。
  "entities": [ // 定义TypeORM需要查找的数据模型的,可以定义多个
      "src/entity/**/*.ts"
  ],
  "migrations": [ // 数据迁移文件生成的地方
      "src/migration/**/*.ts"
  ],
  "subscribers": [ // 订阅(用的少)
      "src/subscriber/**/*.ts"
  ],
  "cli": { // 数据迁移工具使用的
      "entitiesDir": "src/entity",
      "migrationsDir": "src/migration",
      "subscribersDir": "src/subscriber"
  }
}
  • __dirname

/

/ 指的是根目录,比如这样一个目录 root/admin/aaa/bbb/ccc.js,当使用/时,就代表了root目录。

./

./ 指的是当前目录,比如 ./ 出现在上述目录中的ccc.js中,则 ./ 代表 root/admin/aaa/bbb/目录。

. ./

. ./ 指的是上一级目录,若还是出现在上述目录中的ccc.js中,则 ../ 代表root/admin/aaa/目录。

__dirname

__dirname 指的是当前目录的绝对路径,若出现在上述ccc.js中,则代表root/admin/aaa/bbb/目录。

console.log(__dirname + '/dirname01.js');

输出结果:/Users/hanyajun/Desktop/upyun/test/dirname/dirname01.js

2.3 创建实体 Entity

Entity 是由 @Entity 装饰器装饰的模型。 TypeORM 会为此类模型创建数据库表。

新建文件 src/service/entities/service.entity.ts

import {
  Column,
  CreateDateColumn,
  UpdateDateColumn,
  Entity,
  PrimaryGeneratedColumn,
} from 'typeorm';

@Entity('service') // 数据库表明 { name: 'service' }
export class Service {
  @PrimaryGeneratedColumn({
    name: 'service_id',
    type: 'int',
    comment: '主键 id',
  })
  serviceId: number;

  @Column({
    name: 'account_name',
    type: 'varchar',
    length: 20,
    comment: 'UPYUN 账号名',
  })
  accountName: string;

  @Column({
    name: 'sell_id',
    type: 'int',
    width: 11,
    comment: '所属销售id',
  })
  sellId: number;

  @Column({
    name: 'storage_total',
    type: 'bigint',
    width: 20,
    comment: '总空间字节大小',
  })
  storageTotal: number;

  @Column({
    name: 'flow_day_average',
    type: 'decimal',
    comment: '日均流量 30天计',
  })
  flowDayAverage: number;

  @Column({
    name: 'flow_day_peak',
    type: 'decimal',
    comment: '一天流量的峰值',
  })
  flowDayPeak: number;

  @Column({
    name: 'account_status',
    type: 'varchar',
    length: 20,
    comment: '账号状态',
  })
  accountStatus: string;

  @CreateDateColumn({
    name: 'created_at',
    comment: '创建时间',
  })
  createdAt: Date;

  @UpdateDateColumn({
    name: 'updated_at',
    comment: '修改时间',
  })
  updated_at: Date;

  @Column({
    name: 'important',
    type: 'int',
    width: 5,
    comment: '重要度',
  })
  important: number;

  @Column({
    name: 'bill_month_average',
    type: 'decimal',
    comment: '月均消费 6月计',
  })
  billMonthAverage: number;

  @Column({
    name: 'bill_total',
    type: 'decimal',
    comment: '消费总量',
  })
  billTotal: number;

  @Column({
    name: 'flow_left',
    type: 'bigint',
    width: 20,
    comment: '剩余流量',
  })
  flowLeft: number;

  @Column({
    name: 'flow_yestoday',
    type: 'decimal',
    comment: '',
  })
  flowYestoday: number;

  @Column({
    name: 'scale',
    type: 'float',
    comment: '等级',
  })
  scale: string;

  @Column({
    name: 'days_last_mon_200mb',
    type: 'int',
    width: 2,
    comment: '',
  })
  daysLastMon200mb: number;

  @Column({
    name: 'days_this_mon_200mb',
    type: 'int',
    width: 2,
    comment: '',
  })
  daysThisMon200mb: number;

  @Column({
    name: 'first_buy_time',
    type: 'bigint',
    width: 20,
    comment: '第一次购买时间',
  })
  firstBuyTime: number;

  @Column({
    name: 'call_type',
    type: 'varchar',
    length: 20,
    comment: '沟通方式',
  })
  callType: string;

  @Column({
    name: 'buy_type',
    type: 'varchar',
    length: 20,
    comment: '购买方式',
  })
  buyType: string;

  @Column({
    name: 'company',
    type: 'varchar',
    length: 15,
    comment: '公司',
  })
  company: string;

  @Column({
    name: 'allotted_at',
    type: 'int',
    width: 15,
    comment: '',
  })
  allottedAt: number;

  @Column({
    name: 'coupon_remain',
    type: 'decimal',
    comment: '',
  })
  couponRemain: number;
}


  • 关于@Entity()中可扩充的参数

    • name配置映射到数据库表名,如果不指定会以实体类名字创建数据表
    • orderBy排序方式(一般不用)
    • engine引擎(一般不用)\
    • database数据库(一般不用,除非多个数据库的时候)
  • 不管是使用@PrimaryGeneratedColumn()、@Column()等装饰器装饰字段的我们都叫字段装饰器

    • @PrimaryGeneratedColumn假设你希望 id 列自动生成(这称为 auto- increment/sequence/serial/generated identity column)。为此你需要将@PrimaryColumn装饰器更改为@PrimaryGeneratedColumn装饰器

    • type配置字段类型,在mysql中字符类型可能是char、varchar、text,数字类型可能是int、tinyint,小数类型可能是float、double、decimal(10,2)等

    • name真正映射到mysql数据库中字段名字,如果不指定会默认以对象的字段为名字(建议都指定)

    • length长度,比如在mysql中字段为varchar的时候指定字段长度

    • nullable在mysql中字段是否可以为NULL值,默认为false

    • select改字段是否可以被查询出来(针对使用typeORM的查寻操作,不针对你使用原生SQL语句操作),默认为true表示可以被查询出来

    • default默认值,比如插入数据的时候,没传递该字段的值,就默认一个值

    • unique是否唯一约束

    • comment备注该字段是做什么的(建议都写上,方便阅读)

    • enum枚举类型

    • array该列是否以数组

    • precision 数据库字段/列的精度

    • 其他设置

2.4 启动应用

npm run start
或者
npm run start:dev

启动后可以发现数据库自动被初始化,并且 Service 这个表也会创建出来。

image.png

2.5 在src/service/service.module.ts中定义使用哪些存储库

import { Module } from '@nestjs/common';
import { ServiceController } from './service.controller';
import { ServiceService } from './service.service';
import { Service } from './entities/service.entity';
import { TypeOrmModule } from '@nestjs/typeorm';
@Module({
  imports: [TypeOrmModule.forFeature([Service])],
  controllers: [ServiceController],
  providers: [ServiceService],
  exports: [ServiceService],
})
export class ServiceModule {}

2.6 使用 DTO

DTO(数据传输对象)模式。DTO是一个对象,它定义了如何通过网络发送数据。我们可以通过使用 TypeScript 接口(Interface)或简单的类(Class)来定义 DTO 模式。有趣的是,我们在这里推荐使用类。为什么?类是 JavaScript ES6 标准的一部分,因此它们在编译后的 JavaScript 中被保留为实际实体。另一方面,由于 TypeScript 接口在转换过程中被删除,所以 Nest 不能在运行时引用它们。这一点很重要,因为诸如管道(Pipe)之类的特性为在运行时访问变量的元类型提供更多的可能性。

在 java 里面

DTO: 数据传输对象,原先是为分布式提供粗粒度的数据实体,减少调用次数来提升性能和降低网络压力。

简单来说,就是定义一个数据,作用类似于定义方法的入参,而且还能方便我们做其他事情。比如我们的表单验证就可以在 DTO 中使用。

我们一般在使用DTO类来继承entity实体类,在DTO类里放一些业务字段,并提供get set方法。当我们在业务逻辑层或者交互层用到一些数据库中不存在的字段时,我们就需要在DTO类里仿这些字段,这些字段的意义就相当于一些经处理过的数据库字段,实质意义就是方便数据交互,提高效率。

DTO

2.7 nestjs关于class-transformer的实践

class-transformer

2.8 class-validator验证修饰器

class-validator

2.9 typeORM 与 mySql语句的对应关系

typeorm-mysql

typeorm查询生成器

typeorm官方文档querybuilder查询部分搬运

typeorm官方文档-Querybuilder

2.10 gitee对应项目