详解使用Typescript开发node.js项目(简单的环境配置(2)

这是由于typescript自身的机制,需要一份xx.d.ts声明文件,来说明模块对外公开的方法和属性的类型以及内容。感觉有一些麻烦。好在,官方以及社区已经准备好了方案,来解决这个问题。

在TypeScript 2.0以上的版本,获取类型声明文件只需要使用npm。在项目目录下执行安装:

npm install --save-dev @types/node

就可以获得有关node.js v6.x的API的类型说明文件。之后,就可以顺利的导入需要的模块了:

import * as http from 'http';

完成之后,不仅可以正常的使用http模块中的方法,也可以在vscode中获得相应的代码提示。

对于内建模块,安装一个@types/node模块可以整体解决模块的声明文件问题。那么,对于浩如烟海的第三方模块,该怎么办呢?官方和社区中也提供了查找和安装的渠道:

自动编译和自动重启服务

解决完了声明文件之后,其实我们已经可以使用ts简单的进行node.js项目的开发了。但是,每次写完或者修改代码,就要编译,然后再启动,是一件不大但是相当让人烦躁的事情。为了效率,我们应当改善它。

首先,要让.ts文件可以自动被编译。这在上文中的tsconfig.json文件中,已经被设置好了,就是"watch":true 。此时在命令行执行tsc命令后,编译器就会时时监控目录中.ts文件的变化,然后自动编译。

自动重启node服务器,我们可以使用 supervisor 模块解决,或者任何具有类似功能的解决方案都可以。

全局安装supervisor模块npm install -g supervisor,之后就可以在终端中使用supervior ./build/server.js启动服务器,并在服务器端代码改变之后,自动重启服务器。

让启动服务更简单

由于以上的2个命令,在启动时都可能需要附加一些参数,每次输入很麻烦。

可以使用npm script来解决。在package.json文件中的"scripts"中,我们设置:

{ "scripts":{ "dev": "supervisor -w build ./build/server.js", "build": "tsc", } }

执行npm run dev之后,如果./build目录中的.js文件发生改变时,就会重启服务器。

执行npm run build时,则只会编译ts文件并监控ts的改变。

使用例子来试验一下

import * as http from 'http'; //==================== const server = http.createServer(function(request:http.IncomingMessage,response:http.ServerResponse):void{ console.log("create a server..."); response.writeHead(200,{'Content-Type':'text/plain'}); response.write('Hello world,we use typescript to develop.'); response.end(); }); server.listen(3000,function(){ console.log("Server listening on port 3000"); console.log("test..."); });

补充:一个命令实现tsc编译和重启服务器

2017.5.3更新:

感谢大家对本文的支持。有朋友(@Ajaxyz)提出,有没有办法将ts编译监视和重启服务器合并为一个命令?

这里提出一个比较简易的方法,使用gulp来管理这2个流程。(如何使用gulp工作,请参考Gulp API)

1. 使用gulp的watch()来监控ts文件的变化并重启服务器。

这种方式,需要使用gulp和gulp-typescript插件(安装

注意的一点是:gulp-typescript可能需要在项目的目录安装typescript,所以可以在项目的目录中,运行命令行:

npm install typescript

准备好gulp和插件之后,需要书写一份gulpfile.js作为gulp项目需要执行的任务文件,例子如下:

//gulpfile.js let gulp = require('gulp'); let ts = require('gulp-typescript'); let tsp = ts.createProject('tsconfig.json'); //使用tsconfig.json文件配置tsc let exec = require('child_process').exec; let child; //目录常量 const PATHS = { scripts:['./src/**/*.ts'], output:'./build', }; //编译ts文件 gulp.task('build-ts',['restart'],function(){ return gulp.src(PATHS.scripts) .pipe(tsp()) .pipe(gulp.dest(PATHS.output)); }); //监视ts文件变化 gulp.task('watch-ts',['build-ts'],function(){ gulp.watch(PATHS.scripts,['build-ts']); }); //自动重启服务器 gulp.task('restart',function(){ child = exec('supervisor -w build ./build/server.js',(error,stdout,stderr)=>{ console.log(`stdout: ${stdout}`); console.log(`stderr: ${stderr}`); if (error !== null) { console.log(`exec error: ${error}`); } }); }); //开发任务 gulp.task('dev',['build-ts','restart','watch-ts']);

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/wyzwds.html