npm 私有模块的3种方法

在前端/Nodejs 开发中我们通常会开发出公共的 module,但在企业开发功能模块时并不希望将自己的核心代码发布到 npmjs.org 中,虽然 npmjs.org 提供了私有的方法,更多企业还是倾向将代码控制在内网环境中,今天我们来介绍一下npm 私有模块的3种主流方法。

方法一:git + npm link

先来看一下npm install 文档。 npm 支持安装 git 仓库,支持 git , git+ssh , git+http , git+https , or git+file 几种协议,例如:

npm install git+<https://xxx.com/private-package.git>

这样会安装这个仓库的最新版本,如果需要指定版本依赖可以使用 git 的 Tag 来控制。

使用 Tag 控制版本

npm install git+https://xxx.com/private-package.git#v1.0.0

npm link 的使用

很多时候我们需要修改 private-package 模块,但又不想每次先提交git,再执行 npm install 命令来看效果,这样效率太低也太麻烦,npm link 可以帮助我们很方便的实现这样的功能。

来看一下如何使用:

# clone 私有包
git clone https://xxx.com/private-package.git
# 进入私有包目录
cd private-package
# 创建全局的link
npm link

# 进入项目目录
cd ../project/abc
# 将private-package link 到项目
npm link private-package

# 取消link 
npm unlink private-package

也可以直接进入项目目录

cd ~/project/abc
# link 相对路径的 private-package
npm link ../private-package

# 取消相对路径的 private-package
npm unlink ../private-package

这种方式成本最低,试用于规模比较小的团队,无需搭建私服,只要 git 仓库就可以搞定。

方法二:CNPM 私服

cnpm 是国内 IT 大厂淘宝开发的包管理工具,大多数的同学应该都用 cnpm 的客户端命令,其实 cnpm 还有一个很重要的功能,就是搭建私服。

这里偷个懒,只介绍使用 docker-componse 来搭建私服:

# clone
git clone https://github.com/cnpm/cnpmjs.org.git
# 进入目录
cd cnpmjs.org
修改 ./docs/dockerize/config.js 配置

有3个配置是值得我们注意的:

// 默认是 false,在同一个局域网里任何用户都可以publish,为 true 时只有管理员才可以publish,不过没有其他网络环境,没测试过
enablePrivate: false,

// 发布的私有模块必须指定scope,不能是全局的模块,所有这里我们可以添加自己公司的scope,如:@xbl
scopes: [ '@cnpm', '@cnpmtest', '@cnpm-test', '@xbl' ],

// 这里我们可以写一些全局的私有模块名称,为了之前我们可能使用过git的方式
privatePackages: [],

cnpm 更推荐使用 @scope 的方式,也可以避免与公共包重名的情况。

修改好之后在目录下执行下面命令:

# 启动服务
docker-compose up -d

此时会暴露出两个端口,web 地址为 http://127.0.0.1:7002/ ,提交模块的地址为 http://127.0.0.1:7001

停止服务
# 停止服务
docker-componse down 

# 停止服务并不会删除将数据删除,如果有测试需要可以执行如下命令:
# 停止服务同时删除容器中挂载的卷数据
docker-componse down -v 

编写私有模块

为了方便我们可以在自己的项目中添加 .npmrc 文件

registry=http://localhost:7001/
# 或者指定 scope 才走私服
@xbl:registry=http://localhost:7001/

修改私有模块的package.json,添加scope

{
  "name": "@xbl/private-package",
  "version": "1.0.0",
  "description": "private",
  "main": "index.js",
  ...
}

然后执行

# 登录,在同一个局域网内随便写用户名、密码...
npm adduser
# 发布模块
npm publish

使用私有模块

在项目中添加 .npmrc 文件,与前面写法一致。

执行安装命令:

npm install @xbl/private-package

总结

这种方式更适合更大规模的团队,需要占用服务器资源,有些公司可能还需要 DevOps 同事的支持。因为是自己的私服,安装模块可以不走公网,只走公司内网,安装模块的速度会更快。

参考:

https://www.zybuluo.com/chris-ren/note/435419

https://segmentfault.com/a/1190000005946580

方法三:Nexus 私服

最后要说的这个就厉害了,Nexus 大家应该知道是对 Maven 包管理的私服工具,其实他还支持 npm 、docker 、yum 等等。

安装

同样使用 docker 启动服务:

docker run -d --restart=unless-stopped  --name nexus \
-p 8081:8081 -p 5000:5000 -p 5001:5001 -p 5002:5002 -p 5003:5003 -p 5004:5004 \
--ulimit nofile=90000:90000 \
-v /你的磁盘绝对路径:/nexus-data \
-e INSTALL4J_ADD_VM_PARAMS="-Xms2g -Xmx2g" \
sonatype/nexus3:3.8.0

启动需要等待一小会,服务启动后访问:http://127.0.0.1:8081/

停止服务:

docker stop nexus
# 再次启动
docker start nexus

登录

默认使用的用户名密码是: admin/admin123

配置

登录之后点击【配置】:

nexus01.png
创建存储
创建存储
创建Repositories
创建Repositories
创建 npm Repositories
创建 npm Repositories

这里可以看到3个npm…难道是他们兄弟多吗?这里需要解释一下

  • npm (proxy) 看名字就知道是代理仓库
  • npm (hosted) 是私有仓库
  • npm (group) 是组合前面两个,最终暴露出的
创建代理仓库
npm-proxy

需要填的就3个字段

Name: 仓库的名字

Remote storage: 远程仓库地址,例如:https://registry.npmjs.org 或者使用淘宝的:https://registry.npm.taobao.org

Blob store:选择我们刚刚创建好的存储

创建 npm (hosted) 仓库
npm (hosted)
创建npm (group) 仓库
npm (group)

这里值得注意的是 Members 的顺序,会优先选择我们的 npm-private ,然后再走proxy,即便是重名也会优先下载私服的模块。

创建用户

npm (hosted)

配置 .npmrc 文件

npm (npmrc)

复制这个 url 到.npmrc 文件

registry=http://localhost:8081/repository/npm-group/

修改私有模块的 package.json

{
  "name": "private-package",
  "version": "1.0.0",
  ...
  "publishConfig": {
    "registry": "http://localhost:8081/repository/npm-private/"
  },
  ...
}

要注意这里的 publishConfig 填写的是 npm (hosted) 的仓库地址。接下来我们正常执行发布流程就 ok 了!

小技巧

因为每次执行 npm adduser 的时候都需要输入用户名、密码和email 很麻烦,我们都可以配置在.npmrc 文件中,在命令行中执行如下脚本:

echo -n 'myuser:mypassword' | openssl base64

会得到一个 base64 的字符串

修改 .npmrc

registry=http://0.0.0.0:8081/repository/npm-group/
_auth=YmFvYmFvOmJhb2Jhbw==
email=xie@xie.com

这种方式更适应于比较大的团队,支持全局私有包和 @scope 多种方式,使用起来会更加自由。而且不仅适用于前端团队,后端同学甚至 DevOps 都可以共用 Nexus 服务。

参考:https://blog.sonatype.com/using-nexus-3-as-your-repository-part-2-npm-packages

总结

今天为大家介绍了3种主流的 npm 私有模块使用方法,大家可以根据团队的情况自行选择,没有最好的方案,只有最适合。欢迎大家批评指正,谢谢!

原文链接:https://xbl.github.io/2018/03/15/npm-private/

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,529评论 5 475
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,015评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,409评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,385评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,387评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,466评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,880评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,528评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,727评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,528评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,602评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,302评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,873评论 3 306
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,890评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,132评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,777评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,310评论 2 342

推荐阅读更多精彩内容

  • nexus 纯小白文,如有雷同,大概率我参考了你的文档。 1.在本地运行nexus 附上下载链接:Nexus Re...
    pengji阅读 24,415评论 9 11
  • 痛点 有时候执行npm install命令安装某些模块的时候,特别慢,经常安装失败 公司内部的模块如何维护? 我们...
    艾伦先生阅读 2,065评论 2 4
  • 什么是 NPM npm之于Node,就像pip之于Python,gem之于Ruby,composer之于PHP。 ...
    ihoey阅读 6,245评论 2 36
  • 在放假那一天,老师说过,放暑假是为了让我们拉开差距,于是我去上了作文课,在作文课上我们过得很轻松也很愉快,让我...
    任嘟嘟嘟阅读 640评论 0 0