设为首页 收藏本站
云服务器等爆品抢先购,低至4.2元/月
查看: 754|回复: 0

[经验分享] 使用npm制作nodejs模块包

[复制链接]

尚未签到

发表于 2017-2-21 12:51:44 | 显示全部楼层 |阅读模式

NodeJS 是一门年轻的语言,扩展模块并不太全,经常我们想用某个模块但是却找不到合适的。比如前两天我需要使用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 并填入相关信息后的结果:




[plain]view
plaincopy








  • <spanstyle="color:#333333;">$npminit

  • Packagename:(hello)//模块名字,npminit会自动取当前目录名作为默认名字,这里不需要改,直接确认即可

  • Description:Aexampleforwriteamodule//模块说明

  • Packageversion:(0.0.0)0.0.1//模块版本号,这个大家按自己习惯来定就可以

  • Projecthomepage:(none)//模块的主页,如果有的话可以填在这里,也可以不填

  • Projectgitrepository:(none)//模块的git仓库,选填。npm的用户一般都使用github做为自己的git仓库

  • Authorname:ElmerZhang//模块作者名字

  • Authoremail:(none)freeboy6716@gmail.com//模块作者邮箱

  • Authorurl:(none)http://www.elmerzhang.com//模块作者URL

  • Mainmodule/entrypoint:(none)hello.js//模块的入口文件,我们这里是hello.js</span><spanstyle="color:#ff6666;">(这个必填)</span><spanstyle="color:#333333;">

  • Testcommand:(none)//测试脚本,选填

  • Whatversionsofnodedoesitrunon?(~v0.5.7)*//依赖的node版本号,我们这个脚本可以运行在任何版本的node上,因此填*

  • Abouttowriteto/home/elmer/hello/package.json

  • //以下是生成的package.json文件内容预览

  • {

  • "author":"ElmerZhang<freeboy6716@gmail.com>(http://www.elmerzhang.com)",

  • "name":"hello",

  • "description":"Aexampleforwriteamodule",

  • "version":"0.0.1",

  • "repository":{

  • "url":""

  • },

  • "main":"hello.js",

  • "engines":{

  • "node":"*"

  • },

  • "dependencies":{},

  • "devDependencies":{}

  • }



  • Isthisok?(yes)//对以上内容确认无误后,就可以直接回车确认了</span>








到此为止,我们这个模块就写完了。这时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来安装你的模块了。

运维网声明 1、欢迎大家加入本站运维交流群:群②:261659950 群⑤:202807635 群⑦870801961 群⑧679858003
2、本站所有主题由该帖子作者发表,该帖子作者与运维网享有帖子相关版权
3、所有作品的著作权均归原作者享有,请您和我们一样尊重他人的著作权等合法权益。如果您对作品感到满意,请购买正版
4、禁止制作、复制、发布和传播具有反动、淫秽、色情、暴力、凶杀等内容的信息,一经发现立即删除。若您因此触犯法律,一切后果自负,我们对此不承担任何责任
5、所有资源均系网友上传或者通过网络收集,我们仅提供一个展示、介绍、观摩学习的平台,我们不对其内容的准确性、可靠性、正当性、安全性、合法性等负责,亦不承担任何法律责任
6、所有作品仅供您个人学习、研究或欣赏,不得用于商业或者其他用途,否则,一切后果均由您自己承担,我们对此不承担任何法律责任
7、如涉及侵犯版权等问题,请您及时通知我们,我们将立即采取措施予以解决
8、联系人Email:admin@iyunv.com 网址:www.yunweiku.com

所有资源均系网友上传或者通过网络收集,我们仅提供一个展示、介绍、观摩学习的平台,我们不对其承担任何法律责任,如涉及侵犯版权等问题,请您及时通知我们,我们将立即处理,联系人Email:kefu@iyunv.com,QQ:1061981298 本贴地址:https://www.yunweiku.com/thread-345308-1-1.html 上篇帖子: NodeJs 多核多进程并行框架 下篇帖子: Nodejs+Grunt配置SASS项目自动编译
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

扫码加入运维网微信交流群X

扫码加入运维网微信交流群

扫描二维码加入运维网微信交流群,最新一手资源尽在官方微信交流群!快快加入我们吧...

扫描微信二维码查看详情

客服E-mail:kefu@iyunv.com 客服QQ:1061981298


QQ群⑦:运维网交流群⑦ QQ群⑧:运维网交流群⑧ k8s群:运维网kubernetes交流群


提醒:禁止发布任何违反国家法律、法规的言论与图片等内容;本站内容均来自个人观点与网络等信息,非本站认同之观点.


本站大部分资源是网友从网上搜集分享而来,其版权均归原作者及其网站所有,我们尊重他人的合法权益,如有内容侵犯您的合法权益,请及时与我们联系进行核实删除!



合作伙伴: 青云cloud

快速回复 返回顶部 返回列表