NodeJS 模块开发及发布详解分享


Posted in NodeJs onMarch 07, 2012

比如前两天我需要使用hmac和sha1来做签名,就没有找到一个比较好用的模块,这时候就需要我们自己来实现相应的功能了。自己写完之后,再把它打包成一个模块分享给大家来用,即方便了其他人,又能让自己有点小小的成就感,实在是一件一举多得的好事情。接下来,我就为大家介绍一下如何封装一个NodeJS模块并把它分享给其他人。

NPM (Node Package Manager, http://npmjs.org ) 是 NodeJS 的模块管理软件,除 NodeJS 内置的核心模块外,其他模块的安装、卸载等管理操作都要通过 NPM 来进行,我们自己写的模块,就要发布到NPM上来供其他人使用。

接下来,我们做一个非常简单的模块 “hello”,这个模块的功能只有一个:提供一个参数 “name” ,它在控制台输出 “Hello name”。在开始之前,我们首先要把node和npm装好,安装方法在其官方网站都有介绍,这里就不再多说了。

首先,我们创建一个名为”hello”的目录,作为模块的主目录。进入该目录,开始我们的工作。

然后,写模块的核心代码,很简单,只有以下三行:

exports.Hello = function ( name ) { 
console.log( "Hello " + name ); 
}

把它保存为 hello.js。

NodeJS每个扩展模块中都有一个package.json文件,用来描述模块的一些基本属性,比如模块名称、作者、版本号等等。关于package.json写法的详细说明,可以使用 “npm help json” 命令来查看。

我们可以在模块主目录下执行 npm init 来生成一个最基本的package.json。按照命令的提示依次输入信息即可。以下是在 hello 目录下执行 npm init 并填入相关信息后的结果:

$ npm init 
Package name: (hello) //模块名字,npm init会自动取当前目录名作为默认名字,这里不需要改,直接确认即可 
Description: A example for write a module //模块说明 
Package version: (0.0.0) 0.0.1 //模块版本号,这个大家按自己习惯来定就可以 
Project homepage: (none) //模块的主页,如果有的话可以填在这里,也可以不填 
Project git repository: (none) //模块的git仓库,选填。npm的用户一般都使用github做为自己的git仓库 
Author name: Elmer Zhang //模块作者名字 
Author email: (none) freeboy6716@gmail.com //模块作者邮箱 
Author url: (none) http://www.elmerzhang.com //模块作者URL 
Main module/entry point: (none) hello.js //模块的入口文件,我们这里是hello.js 
Test command: (none) //测试脚本,选填 
What versions of node does it run on? (~v0.5.7) * //依赖的node版本号,我们这个脚本可以运行在任何版本的node上,因此填 * 
About to write to /home/elmer/hello/package.json 
// 以下是生成的package.json文件内容预览 
{ 
"author": "Elmer Zhang <freeboy6716@gmail.com> (http://www.elmerzhang.com)", 
"name": "hello", 
"description": "A example for write a module", 
"version": "0.0.1", 
"repository": { 
"url": "" 
}, 
"main": "hello.js", 
"engines": { 
"node": "*" 
}, 
"dependencies": {}, 
"devDependencies": {} 
} 
Is this ok? (yes) //对以上内容确认无误后,就可以直接回车确认了

到此为止,我们这个模块就写完了。这时hello目录下应该有两个文件:hello.js和package.json。

我们可以返回到hello的上级目录,来测试安装一下这个模块:

$ npm install hello/ 
hello@0.0.1 ./node_modules/hello

显示安装成功。简单的测试一下:
$ node 
> var Hello = require('hello').Hello; 
> Hello('world');

Hello world正确输出了”Hello world”。

接下来我们把它发布到NPM上。

首先,我们需要有一个NPM帐号,可以使用npm adduser来注册一个:

$ npm adduser 
Username: elmerzhang 
Password: 
Email: freeboy6716@gmail.com

简单三步,一个NPM用户注册成功。

最后回到 hello 根目录,执行一下npm publish,如果没有任何错误提示,那么就发布成功了。去 http://search.npmjs.org/上看一下吧,你的模块应该已经显示在”Latest Updates”一栏里了。

至此,一个NodeJS模块成功发布到NPM,以后就可以在任何能访问npm库的地方通过npm install来安装你的模块了。

NodeJs 相关文章推荐
iPhone手机上搭建nodejs服务器步骤方法
Jul 06 NodeJs
深入浅析NodeJs并发异步的回调处理
Dec 21 NodeJs
Nodejs下用submit提交表单提示cannot post错误的解决方法
Nov 21 NodeJs
nodejs密码加密中生成随机数的实例代码
Jul 17 NodeJs
理解nodejs的stream和pipe机制的原理和实现
Aug 12 NodeJs
nodejs实现简单的gulp打包
Dec 21 NodeJs
Linux Centos7.2下安装nodejs&amp;npm配置全局路径的教程
May 15 NodeJs
nodejs实现套接字服务功能详解
Jun 21 NodeJs
基于Koa(nodejs框架)对json文件进行增删改查的示例代码
Feb 02 NodeJs
Nodejs监控事件循环异常示例详解
Sep 22 NodeJs
NodeJS http模块用法示例【创建web服务器/客户端】
Nov 05 NodeJs
Nodejs使用archiver-zip-encrypted库加密压缩文件时报错(解决方案)
Nov 18 NodeJs
golang、python、php、c++、c、java、Nodejs性能对比
Mar 12 #NodeJs
PHPStorm 2020.1 调试 Nodejs的多种方法详解
Sep 17 #NodeJs
nodejs实用示例 缩址还原
Dec 28 #NodeJs
nodejs 后缀名判断限制代码
Mar 31 #NodeJs
NodeJS框架Express的模板视图机制分析
Jul 19 #NodeJs
用nodejs访问ActiveX对象,以操作Access数据库为例。
Dec 15 #NodeJs
nodejs入门详解(多篇文章结合)
Mar 07 #NodeJs
You might like
php制作中间带自己定义图片二维码的方法
2014/01/27 PHP
CI框架文件上传类及图像处理类用法分析
2016/05/18 PHP
PHP简单获取多个checkbox值的方法
2016/06/13 PHP
PHP实现redis限制单ip、单用户的访问次数功能示例
2018/06/16 PHP
JS取得绝对路径的实现代码
2015/01/16 Javascript
JavaScript实现点击文字切换登录窗口的方法
2015/05/11 Javascript
JS之获取样式的简单实现方法(推荐)
2016/09/13 Javascript
jQuery ajax的功能实现方法详解
2017/01/06 Javascript
基于JavaScript实现带缩略图的轮播效果
2017/01/12 Javascript
VUE实现日历组件功能
2017/03/13 Javascript
JS组件系列之MVVM组件 vue 30分钟搞定前端增删改查
2017/04/28 Javascript
vue2.0 keep-alive最佳实践
2017/07/06 Javascript
浅谈让你的代码更简短,更整洁,更易读的ES6小技巧
2018/10/25 Javascript
微信小程序实现侧边栏分类
2019/10/21 Javascript
JavaScript 判断浏览器是否是IE
2021/02/19 Javascript
[58:00]DOTA2-DPC中国联赛 正赛 PSG.LGD vs Elephant BO3 第二场 2月7日
2021/03/11 DOTA
Python paramiko模块的使用示例
2018/04/11 Python
如何用Python合并lmdb文件
2018/07/02 Python
Python docx库用法示例分析
2019/02/16 Python
pandas的qcut()方法详解
2019/07/06 Python
Python产生一个数值范围内的不重复的随机数的实现方法
2019/08/21 Python
python中树与树的表示知识点总结
2019/09/14 Python
python 单线程和异步协程工作方式解析
2019/09/28 Python
Keras使用tensorboard显示训练过程的实例
2020/02/15 Python
日本高岛屋百货购物网站:TAKASHIMAYA
2019/03/24 全球购物
对象的序列化(serialization)类是面向流的,应如何将对象写入到随机存取文件中
2015/06/22 面试题
写自荐信有哪些不宜?
2013/10/17 职场文书
展会邀请函范文
2014/01/26 职场文书
竞选卫生委员演讲稿
2014/04/28 职场文书
房产遗嘱范本
2015/08/06 职场文书
三八红旗手先进事迹材料(2016推荐版)
2016/02/25 职场文书
详解php中流行的rpc框架
2021/05/29 PHP
Vue.js中v-for指令的用法介绍
2022/03/13 Vue.js
Pandas-DataFrame知识点汇总
2022/03/16 Python
Python写情书? 10行代码展示如何把情书写在她的照片里
2022/04/21 Python
Mysql将字符串按照指定字符分割的正确方法
2022/05/30 MySQL