天天看點

【Express+TypeScript+MongoDB】項目搭建

環境配置

安裝 node

nodeJs官網下載下傳https://nodejs.org/zh-cn/,一路next就可以了,預設安裝是在C槽

配置cnpm鏡像 

npm install -g cnpm --registry=https://registry.npm.taobao.org
           

如果想安裝在其他盤,可參考 https://www.cnblogs.com/jianguo221/p/11487532.html

全局安裝 typescript

npm i typescript -g
           

 全局安裝 express,可以直接用express的指令建立node-express項目

全局安裝Express
npm install express-generator -g

建立node-express 項目
express server(項目名)
           

 本文不使用express建立,這裡就一筆帶過了

項目建立

建立項目檔案夾
mkdir server

--yes預設所有配置
npm init --yes
           

建立成功後,會生成一個package.json檔案,暫時先不修改

引入項目初始化必要的插件

@typpes是支援ts的插件
body-parser 可以配置接收不同格式的請求,即application/json 或 application/x-www-form-urlencoded
npm i express @types/node @types/express cors @types/cors body-parser

安裝開發環境需要的依賴,rimraf其實在部署運作時會用到,但其是運作前的指令,算[開發環境];
ts-node-dev 開發用這個來啟動本地服務,因為node不能直接運作ts的代碼
npm i -D typescript ts-node-dev rimraf
           

建立,并修改tsconfig.json配置

tsc --init
           
{
  "compilerOptions": {
    /* Visit https://aka.ms/tsconfig.json to read more about this file */

    /* Basic Options */
    // "incremental": true,                   /* Enable incremental compilation */
    "target": "ES6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
    // "lib": [],                             /* Specify library files to be included in the compilation. */
    // "allowJs": true,                       /* Allow javascript files to be compiled. */
    // "checkJs": true,                       /* Report errors in .js files. */
    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
    "sourceMap": true,                        /* Generates corresponding '.map' file. */
    // "outFile": "./",                       /* Concatenate and emit output to single file. */
    "outDir": "./build",                        /* Redirect output structure to the directory. */
    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
    // "composite": true,                     /* Enable project compilation */
    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
    "removeComments": true,                   /* Do not emit comments to output. */
    // "noEmit": true,                        /* Do not emit outputs. */
    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */

    /* Strict Type-Checking Options */
    "strict": true,                           /* Enable all strict type-checking options. */
    "noImplicitAny": false,                   /* Raise error on expressions and declarations with an implied 'any' type. */
    "strictNullChecks": true,              /* Enable strict null checks. */
    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
    "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */

    /* Additional Checks */
    // "noUnusedLocals": true,                /* Report errors on unused locals. */
    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
    // "noUncheckedIndexedAccess": true,      /* Include 'undefined' in index signature results */

    /* Module Resolution Options */
    "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
    "baseUrl": "./src",                       /* Base directory to resolve non-absolute module names. */
    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
    // "typeRoots": [],                       /* List of folders to include type definitions from. */
    // "types": [],                           /* Type declaration files to be included in compilation. */
    "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */

    /* Source Map Options */
    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */

    /* Experimental Options */
    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */

    /* Advanced Options */
    "skipLibCheck": true,                     /* Skip type checking of declaration files. */
    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
  },
  "include": [
    "./src/**/*"
  ]
}
           

修改完成之後,就在目前目錄(server)下建立build、src兩個檔案夾,在src目錄下建立app.ts和server.ts兩個檔案

【Express+TypeScript+MongoDB】項目搭建

修改package.json,配置腳本指令

"scripts": {
    "build": "tsc",
    "dev": "ts-node-dev --respawn --transpile-only ./src/server.ts",
    "restart": "rimraf dist && npm run build && npm start",
    "start": "node ./build/server.js",
    "prod": "npm run build && npm run start"
  },
           

app.ts,添加如下代碼

import express from 'express';

class App {
  public app: express.Application;
  constructor() {
    this.app = express();
  }
}

export default new App().app;
           

server.ts,添加如下代碼

import app from './app'
const PORT = 3000;

app.listen(PORT,() => {
  console.log(`Express server listening on port ${PORT}`);
});
           

然後npm run dev 啟動項目,express+TS的項目算是完成搭建的第一步

【Express+TypeScript+MongoDB】項目搭建

下一篇:【Express+TypeScript+MongoDB】配置路由 & 連接配接資料庫

參考

https://blog.csdn.net/qq_37674616/article/details/103104616

繼續閱讀