大家好,我是小L,说实话,npm私有库不是一个新鲜名词了,但这个概念我是第一次接触的。以下内容为本人半手打半复制,各位看官将就阅览,如有不当之处,还望不吝赐教,尽情指正,拜谢!
本篇文章分为两大板块,即npm及npm私有库。我觉得要想搞清楚什么是npm私有库,那么我们有必要知道什么是npm呢?
一、npm的前世今生
众所周知,开发人员离不开一种叫做社区的组织的支持,而分享应该是每个优秀程序员都应该具备的美德、品质,并且我觉得称为一种技能提升的路径也未尝不可。而世界上最大的前端社区应该就是 GitHub 了吧。刚才已经提到我们愿意分享自己的代码,那么我们是怎么分享自己的代码的呢?在 GitHub 还没有兴起的年代,前端是通过网址来共享代码的。比如你想使用 jQuery,那么你点击 jQuery 网站上提供的链接就可以下载 jQuery,放到自己的网站上使用。
GItHub 兴起之后,社区中也有人使用 GitHub 的下载功能,但是当一个网站依赖的代码越来越多,程序员发现这是一件很麻烦的事情,于是一个拥有三大美德的程序员Isaac Z. Schlueter出现了,嗯,简称盲仔吧,因为看到Isaaz我总是想到InSec,啊哈哈哈哈哈哈哈嗝。
盲仔给出一个解决方案:用一个工具把这些代码集中到一起来管理吧!
这个工具就是他用JavaScript(运行在Node.js上)写的npm,全称是Node Package Manager。
NPM 的思路大概是这样的:
1. 买个服务器作为代码仓库(registry),在里面放所有需要被共享的代码
2.发邮件通知jQuery、Bootstrap、Underscore作者使用npm publish把代码提交到registry上,分别取名jquery、bootstrap和underscore(注意大小写)
3.社区里的其他人如果想使用这些代码,就把jquery、bootstrap和underscore写到package.json里,然后运行npm install,npm就会帮他们下载代码
4. 下载完的代码出现在 node_modules 目录里,可以随意使用了。
这些可以被使用的代码被叫做「包」(package),这就是 NPM 名字的由来:Node Package(包) Manager(管理器)。
但是盲仔不是wxz啊,其他作者不一定答应用他的npm啊,但是npm依旧发展了起来,因为Node.js的存在,Node.js刚出来的时候是缺少一个包管理器的,于是Node.js的作者和盲仔,王八瞅绿豆,干柴遇烈火,和尚碰尼姑,咳咳,总之这件事就这么水到渠成,他俩竟然媾和了!!!他俩合作了。最终 Node.js 内置了 npm。随着 Node.js 的火爆,大家开始用 npm 来共享 JS 代码了,于是 jQuery 作者也将 jQuery 发布到 npm 了。所以现在,你可以使用 npm install jquery 来下载 jQuery 代码。现在用 npm 来分享代码已经成了前端的标配。
二、什么是npm私有库&为什么要用npm私有库
为什么用npm私有库以及什么是npm私有库我觉得可以当作一个问题来处理,毕竟有需求才会有市场,没有买卖就没有杀害。
上文说到,npm可以看作一个平台,大家把自己的代码传上去给其他人用,这些代码当然都是开源的,那么总有一些东西我们是不想让其他人知道的,而我们把这些不想让人看到的东西存到自己的私有服务器上就是npm私有库了。
那么为什么会用到npm私有库呢?
总结了以下四点:
1、公司出于自身隐私保护需要,不想把自己的代码开源到包管理区,但是需要一套完整包管工具,来管理越来越多的组件、模块和项目,这个时候就需要有自己本地的仓库了;
2、有些公司采用的是内网开发,很多npm资源无法从内网去下载;
3、对于发布和下载npm包可以配置权限管理,自己管理包的同时借助npm的命令行工具快速复用业务代码模块或者业务组件;
4、下载包的速度更快
三、npm私有库的搭建
在网上查了好多资料,有使用maven包管理的私服工具nexus搭建私有仓库的,也有使用阿里的cnpm搭建私有仓库的,还有使用sinopia和verdaccio搭建私有仓库的,下面介绍一下它们的主要区别:
使用maven包管理的私服工具nexus搭建私有仓库,这种方式功能强大,但更偏向后台使用,服务端的同学应该比较熟悉
阿里的cnpm搭建npm私有仓库,这个是阿里自己内部也在使用的,应该也挺好用,不过需要安装MySQL数据库,而且配置比较麻烦
使用sinopia搭建npm私有仓库,这个使用比较简单,而且不用配置数据库,但是这个项目的作者貌似在2015年10月份不再对其进行维护以及升级,若有小伙伴用了Sinopia搭建,并遇到了一些bug,附上部分bug解决方案(请参考链接https://blog.csdn.net/y491887095/article/details/80247142)。
经过查阅相关资料后对比,最后选择使用verdaccio来搭建npm私有仓库,这个github项目貌似是sinopia的分支,用法和sinopia差不多。
1、安装node
Verdaccio is a lightweight private npm proxy registry built in Node.js
verdaccio是基于node.js的,所以在我们的服务器上需要安装node。
2、安装verdaccio
npm install -g verdaccio --unsafe-perm
加上--unsafe-perm选项是为了防止gyp ERR! permission denied权限问题报错,如下:
gyp ERR! configure error
gyp ERR! stack Error: EACCES: permission denied, mkdir '/usr/local/lib/node_modules/verdaccio/node_modules/dtrace-provider/build'
gyp ERR! System Linux 3.10.0-862.14.4.el7.x86_64
gyp ERR! command "/usr/local/bin/node" "/usr/local/lib/node_modules/npm/node_modules/node-gyp/bin/node-gyp.js" "rebuild"
gyp ERR! cwd /usr/local/lib/node_modules/verdaccio/node_modules/dtrace-provider
gyp ERR! node -v v8.12.0
gyp ERR! node-gyp -v v4.2.0
gyp ERR! not ok
如果出现需要更新npm,则执行npm install -g npm操作
执行结果:
/usr/local/bin/verdaccio
3、启动verdaccio
verdaccio
执行结果如下:
Verdaccio doesn't need superuser privileges. Don't run it under root.
warn --- config file - /Users/z-Luchifer/.config/verdaccio/config.yaml
warn --- Plugin successfully loaded: htpasswd
warn --- Plugin successfully loaded: audit
warn --- http address - http://localhost:4873/ - verdaccio/4.2.0
从控制台的输出,我们可以看到,verdaccio的配置文件路径在/Users/z-Luchifer/.config/verdaccio/config.yaml和默认访问地址http://localhost:4873/,在配置文件末尾增加listen: 0.0.0.0:4873保存
// 进入verdaccio目录
cd /Users/z-Luchifer/.config/verdaccio/
// 查看该目录下的文件,该目录下默认有两个文件:config.yaml和storage,添加用户之后会自动创建htpasswd
ls
> config.yaml storage
// 查看配置文件
vim config.yaml
在配置文件config.yaml末尾加入代码:
# you can specify listen address (or simply a port)
listen: 0.0.0.0:4873
verdaccio默认配置,如下:
storage: ./storage
auth:
htpasswd:
file: ./htpasswd
uplinks:
npmjs:
url: https://registry.npmjs.org/
packages:
'@*/*':
access: $all
publish: $authenticated
proxy: npmjs
'**':
proxy: npmjs
logs:
- {type: stdout, format: pretty, level: http}
其中url可以配置成淘宝镜像地址:
url: https://registry.npm.taobao.org/ //默认为npm的官网仓库地址,由于国情,修改 url 让verdaccio使用 淘宝的npm镜像地址,这样下载速度更快
4、使用pm2启动verdaccio,保证该进程一直处于打开状态
安装pm2
npm install -g pm2 --unsafe-perm
使用pm2启动verdaccio,以保证进程一直处于打开状态
pm2 start verdaccio
执行命令以后结果如图所示:
5、访问搭建好的私有仓库
在浏览器中打开http://47.107.60.51:4873,如果能正常访问则说明搭建成功了。如图:
好了,时光飞逝,岁月如梭,欢乐的时光总是短暂的,文章到这里就结束了,觉得还不错的,请给小L一些物质鼓励吧,啊哈哈哈哈哈哈嗝。擦干眼泪,咽下不舍,须知每一次分离都是为了更美好的相遇,我们有缘下次再见,拜拜😭(文章如有侵权,立即删除)
参考文章: