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 相关文章推荐
Nodejs进程管理模块forever详解
Jun 01 NodeJs
Nodejs Express4.x开发框架随手笔记
Nov 23 NodeJs
NodeJS实现阿里大鱼短信通知发送
Jan 17 NodeJs
使用nodejs下载风景壁纸
Feb 05 NodeJs
Nodejs进阶:express+session实现简易登录身份认证
Apr 24 NodeJs
使用nodejs爬取前程无忧前端技能排行
May 06 NodeJs
NodeJS、NPM安装配置步骤(windows版本) 以及环境变量详解
May 13 NodeJs
Express+Nodejs 下的登录拦截实现代码
Jul 01 NodeJs
nodejs socket服务端和客户端简单通信功能
Sep 14 NodeJs
nodejs+mongodb aggregate级联查询操作示例
Mar 17 NodeJs
基于Koa(nodejs框架)对json文件进行增删改查的示例代码
Feb 02 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
日本十大科幻动漫 宇宙骑士垫底,第一已成经典
2020/03/04 日漫
DedeCMS dede_channeltype表字段注释
2010/04/07 PHP
163的邮件用phpmailer发送(实例详解)
2013/06/24 PHP
php验证session无效的解决方法
2014/11/04 PHP
编写PHP脚本来实现WordPress中评论分页的功能
2015/12/10 PHP
thinkPHP+PHPExcel实现读取文件日期的方法(含时分秒)
2016/07/07 PHP
如何直接访问php实例对象中的private属性详解
2017/10/12 PHP
PHP通过get方法获得form表单数据方法总结
2018/09/12 PHP
PHP使用Http Post请求发送Json对象数据代码解析
2020/07/16 PHP
关于B/S判断浏览器断开的问题讨论
2008/10/29 Javascript
使用js对select动态添加和删除OPTION示例代码
2013/08/12 Javascript
jQuery实现多级下拉菜单jDropMenu的方法
2015/08/28 Javascript
微信小程序 页面跳转传参详解
2016/10/28 Javascript
利用vue写todolist单页应用
2016/12/15 Javascript
js实现三级联动效果(简单易懂)
2017/03/27 Javascript
Webpack性能优化 DLL 用法详解
2017/08/10 Javascript
Three.js基础学习之场景对象
2017/09/27 Javascript
vue实现点击展开点击收起效果
2018/04/27 Javascript
解决layui调用自定义方法提示未定义的问题
2019/09/14 Javascript
vue使用prop可以渲染但是打印台报错的解决方式
2019/11/13 Javascript
Vue组件通信$attrs、$listeners实现原理解析
2020/09/03 Javascript
[00:32]DOTA2上海特级锦标赛 Ehome战队宣传片
2016/03/03 DOTA
从零学Python之入门(四)运算
2014/05/27 Python
Python的内存泄漏及gc模块的使用分析
2014/07/16 Python
Python Numpy 数组的初始化和基本操作
2018/03/13 Python
解决python ogr shp字段写入中文乱码的问题
2018/12/31 Python
python按比例随机切分数据的实现
2019/07/11 Python
python+selenium 点击单选框-radio的实现方法
2019/09/03 Python
Richards网上商店:当代时尚,遍布巴西
2019/11/03 全球购物
病媒生物防治方案
2014/05/13 职场文书
团队激励口号
2014/06/06 职场文书
水污染治理工程专业求职信
2014/06/14 职场文书
2014民事授权委托书范本
2014/09/29 职场文书
质检员岗位职责范本
2015/04/07 职场文书
停发工资证明范本
2015/06/12 职场文书
SQL Server 中的事务介绍
2022/05/20 SQL Server