title | date | categories | tags | featuredImage | ||
---|---|---|---|---|---|---|
Node.js 的使用 |
2019-09-23 17:11:43 +0800 |
|
|
Node.js 是一个基于 Chrome V8 引擎的 JavaScript 运行环境。 Node.js 使用了一个事件驱动、非阻塞式 I/O 的模型,使其轻量又高效。
{{< card "https://nodejs.dev/learn/introduction-to-nodejs" >}}
{{< card "https://nodejs.dev/download/" >}} {{< card "https://nodejs.dev/download/package-manager/" >}}
{{< card "https://nodejs.dev/learn/how-much-javascript-do-you-need-to-know-to-use-nodejs" >}}
{{< card "https://nodejs.dev/learn/run-nodejs-scripts-from-the-command-line" >}}
{{< card "https://nodejs.dev/learn/output-to-the-command-line-using-nodejs" >}}
{{< card "https://nodejs.dev/learn/error-handling-in-nodejs" >}}
Node.js 采用模块化结构,按照 CommonJS 规范定义和使用模块。模块与文件是一一对应关系,即加载一个模块,实际上就是加载对应的一个模块文件。
{{< card "https://nodejs.dev/learn/expose-functionality-from-a-nodejs-file-using-exports" >}} {{< card "https://blog.csdn.net/zhangyuan19880606/article/details/51508699" >}}
- 存在文件作用域
- 存在通信规则
- 加载(require)
- 导出(module.exports)
node 中每个 js 文件,都有一个 module 对象,其 exports 属性相当于其暴露的接口对象。可以使用module.exports.xxx = xxx
添加向外暴露的接口。如果一个文件只向外暴露一个方法或者其他类型的属性,可以直接使用module.exports = xxx
。注意在 Node 解释 js 文件时,会在其头部加上隐式的let exports = module.exports
因此只要不改变指针指向的情况下,可以使用export
代替module.exports
。
- 加载规则
- 会执行加载模块中的代码
- 重复 require,不会执行模块中的代码,仅能拿到
module.exports
接口对象。
- 模块标识
- 核心模块
- 被编译到二进制文件中,直接使用名字加载。
- 第三方模块
- 凡是第三方模块都需要使用 npm 来下载
- 加载的时候使用
require(’packageName’)
- 加载的文件的位置在
node_modules/packageName/package.json
中{”main”:”加载文件“}
- 没有配置加载文件的情况会默认为
index.js
node_modules
文件夹会从当前文件所在路径,向上迭代查找使用最近的一个。
- 自定义模块
./
开头,代表当前路径,不可省。../
开头,代表上级路径,不可省。- 引入时
.js
后缀可省
- 核心模块
{{< card "https://nodejs.dev/learn/an-introduction-to-the-npm-package-manager" >}} {{< card "https://nodejs.dev/learn/where-does-npm-install-the-packages" >}} {{< card "https://nodejs.dev/learn/how-to-use-or-execute-a-package-installed-using-npm" >}} {{< card "https://nodejs.dev/learn/find-the-installed-version-of-an-npm-package" >}} {{< card "https://nodejs.dev/learn/uninstalling-npm-packages" >}} {{< card "https://nodejs.dev/learn/npm-global-or-local-packages" >}} {{< card "https://nodejs.dev/learn/npm-dependencies-and-devdependencies" >}}
{{< card "https://nodejs.dev/learn/the-package-json-guide" >}} {{< card "https://nodejs.dev/learn/the-package-lock-json-file" >}}
如果您使用 JavaScript,或者您曾经与 JavaScript 项目、Node.js 或前端项目进行过交互,那么您肯定会遇到该package.json
文件。
那个有什么用途?你应该知道什么,你可以用它做什么很酷的事情?
该package.json
文件是您项目的清单。它可以做很多事情,完全不相关。例如,它是工具配置的中央存储库。它也是所有已安装软件包的名称和版本的存储npm
位置。yarn
这是一个示例 package.json 文件:
{}
它是空的!package.json
对于应用程序,文件中的内容没有固定要求。唯一的要求是它尊重 JSON 格式,否则尝试以编程方式访问其属性的程序无法读取它。
如果您正在构建一个想要分发的 Node.js 包,npm
事情发生了根本性的变化,那么您必须拥有一组可以帮助其他人使用它的属性。稍后我们将看到更多关于此的内容。
这是另一个 package.json:
{
"name": "test-project"
}
它定义了一个name
属性,该属性告诉应用程序或包的名称,该名称包含在该文件所在的同一文件夹中。
这是一个更复杂的示例,它是从示例 Vue.js 应用程序中提取的:
{
"name": "test-project",
"version": "1.0.0",
"description": "A Vue.js project",
"main": "src/main.js",
"private": true,
"scripts": {
"dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js",
"start": "npm run dev",
"unit": "jest --config test/unit/jest.conf.js --coverage",
"test": "npm run unit",
"lint": "eslint --ext .js,.vue src test/unit",
"build": "node build/build.js"
},
"dependencies": {
"vue": "^2.5.2"
},
"devDependencies": {
"autoprefixer": "^7.1.2",
"babel-core": "^6.22.1",
"babel-eslint": "^8.2.1",
"babel-helper-vue-jsx-merge-props": "^2.0.3",
"babel-jest": "^21.0.2",
"babel-loader": "^7.1.1",
"babel-plugin-dynamic-import-node": "^1.2.0",
"babel-plugin-syntax-jsx": "^6.18.0",
"babel-plugin-transform-es2015-modules-commonjs": "^6.26.0",
"babel-plugin-transform-runtime": "^6.22.0",
"babel-plugin-transform-vue-jsx": "^3.5.0",
"babel-preset-env": "^1.3.2",
"babel-preset-stage-2": "^6.22.0",
"chalk": "^2.0.1",
"copy-webpack-plugin": "^4.0.1",
"css-loader": "^0.28.0",
"eslint": "^4.15.0",
"eslint-config-airbnb-base": "^11.3.0",
"eslint-friendly-formatter": "^3.0.0",
"eslint-import-resolver-webpack": "^0.8.3",
"eslint-loader": "^1.7.1",
"eslint-plugin-import": "^2.7.0",
"eslint-plugin-vue": "^4.0.0",
"extract-text-webpack-plugin": "^3.0.0",
"file-loader": "^1.1.4",
"friendly-errors-webpack-plugin": "^1.6.1",
"html-webpack-plugin": "^2.30.1",
"jest": "^22.0.4",
"jest-serializer-vue": "^0.3.0",
"node-notifier": "^5.1.2",
"optimize-css-assets-webpack-plugin": "^3.2.0",
"ora": "^1.2.0",
"portfinder": "^1.0.13",
"postcss-import": "^11.0.0",
"postcss-loader": "^2.0.8",
"postcss-url": "^7.2.1",
"rimraf": "^2.6.0",
"semver": "^5.3.0",
"shelljs": "^0.7.6",
"uglifyjs-webpack-plugin": "^1.1.1",
"url-loader": "^0.5.8",
"vue-jest": "^1.0.2",
"vue-loader": "^13.3.0",
"vue-style-loader": "^3.0.1",
"vue-template-compiler": "^2.5.2",
"webpack": "^3.6.0",
"webpack-bundle-analyzer": "^2.9.0",
"webpack-dev-server": "^2.9.1",
"webpack-merge": "^4.1.0"
},
"engines": {
"node": ">= 6.0.0",
"npm": ">= 3.0.0"
},
"browserslist": ["> 1%", "last 2 versions", "not ie <= 8"]
}
这里发生了很多事情:
version
表示当前版本name
设置应用程序/包名称description
是应用程序/包的简要说明main
设置应用程序的入口点private
如果设置为true
防止应用程序/包被意外发布npm
scripts
定义了一组可以运行的节点脚本dependencies``npm
设置作为依赖项安装的软件包列表devDependencies``npm
设置作为开发依赖项安装的软件包列表engines
设置此包/应用程序适用于哪些版本的 Node.jsbrowserslist
用于告诉您要支持哪些浏览器(及其版本)
所有这些属性都被npm
我们可以使用的任何一个或其他工具使用。
本节详细介绍了您可以使用的属性。我们指的是“包”,但同样适用于您不用作包的本地应用程序。
大多数这些属性仅在https://www.npmjs.com/上使用,其他属性由与您的代码交互的脚本使用,例如`npm`或其他。
设置包名。
例子:
"name": "test-project"
名称必须少于 214 个字符,不能有空格,只能包含小写字母、连字符 ( -
) 或下划线 ( _
)。
这是因为当一个包在 上发布时npm
,它会根据这个属性获得自己的 URL。
如果您在 GitHub 上公开发布此包,则此属性的一个很好的值是 GitHub 存储库名称。
列出包作者姓名
例子:
{
"author": "Joe <joe@whatever.com> (https://whatever.com)"
}
也可以使用这种格式:
{
"author": {
"name": "Joe",
"email": "joe@whatever.com",
"url": "https://whatever.com"
}
}
除了作者之外,该项目还可以有一个或多个贡献者。该属性是一个列出它们的数组。
例子:
{
"contributors": ["Joe <joe@whatever.com> (https://whatever.com)"]
}
也可以使用这种格式:
{
"contributors": [
{
"name": "Joe",
"email": "joe@whatever.com",
"url": "https://whatever.com"
}
]
}
包问题跟踪器的链接,很可能是 GitHub 问题页面
例子:
{
"bugs": "https://github.com/whatever/package/issues"
}
设置包主页
例子:
{
"homepage": "https://whatever.com/package"
}
表示包的当前版本。
例子:
"version": "1.0.0"
此属性遵循版本的语义版本控制 (semver) 表示法,这意味着版本始终用 3 个数字表示:x.x.x
.
第一个数字是主要版本,第二个是次要版本,第三个是补丁版本。
这些数字有一个含义:仅修复错误的版本是补丁版本,引入向后兼容更改的版本是次要版本,主要版本可以有重大更改。
表示包的许可证。
例子:
"license": "MIT"
此属性包含与您的包的功能相关联的关键字数组。
例子:
"keywords": [
"email",
"machine learning",
"ai"
]
这有助于人们在浏览类似包或浏览https://www.npmjs.com/网站时找到您的包。
此属性包含包的简要说明
例子:
"description": "A package to work with strings"
如果您决定将包发布到npm
以便人们可以了解包的内容,这将特别有用。
此属性指定此包存储库所在的位置。
例子:
"repository": "github:whatever/testing",
注意github
前缀。还有其他受欢迎的服务:
"repository": "gitlab:whatever/testing",
"repository": "bitbucket:whatever/testing",
您可以显式设置版本控制系统:
"repository": {
"type": "git",
"url": "https://github.com/whatever/testing.git"
}
您可以使用不同的版本控制系统:
"repository": {
"type": "svn",
"url": "..."
}
设置包的入口点。
当您在应用程序中导入此包时,应用程序将在其中搜索模块导出。
例子:
"main": "src/main.js"
如果设置为true
防止应用程序/包被意外发布npm
例子:
"private": true
定义一组可以运行的节点脚本
例子:
"scripts": {
"dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js",
"start": "npm run dev",
"unit": "jest --config test/unit/jest.conf.js --coverage",
"test": "npm run unit",
"lint": "eslint --ext .js,.vue src test/unit",
"build": "node build/build.js"
}
这些脚本是命令行应用程序。您可以通过调用npm run XXXX
or 来运行它们yarn XXXX
,其中XXXX
是命令名称。示例:npm run dev
。
您可以为命令使用任何您想要的名称,并且脚本可以执行任何您想要的操作。
npm
设置作为依赖项安装的软件包列表。
使用 npm 或 yarn 安装包时:
BASHcopy
npm install <PACKAGENAME>
yarn add <PACKAGENAME>
该软件包会自动插入此列表中。
例子:
"dependencies": {
"vue": "^2.5.2"
}
npm
设置作为开发依赖项安装的软件包列表。
它们的不同之处dependencies
在于它们只能安装在开发机器上,而不需要在生产中运行代码。
使用 npm 或 yarn 安装包时:
BASHcopy
npm install --save-dev <PACKAGENAME>
yarn add --dev <PACKAGENAME>
该软件包会自动插入此列表中。
例子:
"devDependencies": {
"autoprefixer": "^7.1.2",
"babel-core": "^6.22.1"
}
设置此包/应用程序使用的 Node.js 版本和其他命令
例子:
"engines": {
"node": ">= 6.0.0",
"npm": ">= 3.0.0",
"yarn": "^0.13.0"
}
用于告诉您要支持哪些浏览器(及其版本)。它被 Babel、Autoprefixer 和其他工具引用,仅将 polyfills 和 fallbacks 添加到您的目标浏览器中。
例子:
"browserslist": [
"> 1%",
"last 2 versions",
"not ie <= 8"
]
此配置意味着您希望以至少 1% 的使用率(来自CanIUse.com统计数据)支持所有浏览器的最后 2 个主要版本,IE8 和更低版本除外。
(查看更多)
该package.json
文件还可以托管特定于命令的配置,例如 Babel、ESLint 等。
每个都有一个特定的属性,比如eslintConfig
,babel
等等。这些是特定于命令的,您可以在相应的命令/项目文档中找到如何使用它们。
您已经在上面的描述中看到了像这样的版本号:~3.0.0
或^0.13.0
. 它们是什么意思,您可以使用哪些其他版本说明符?
该符号指定您的包从该依赖项接受哪些更新。
鉴于使用 semver(语义版本控制)所有版本都有 3 位数字,第一个是主要版本,第二个是次要版本,第三个是补丁版本,你有这些“规则”。
您可以组合范围内的大多数版本,例如:1.0.0 || >=1.1.0 <1.2.0
,以使用 1.0.0 或 1.1.0 以上的一个版本,但低于 1.2.0。
{{< card "https://nodejs.dev/learn/the-nodejs-fs-module" >}}
{{< card "https://nodejs.dev/learn/the-nodejs-path-module" >}}
{{< card "https://nodejs.dev/learn/the-nodejs-os-module" >}}
{{< card "https://nodejs.dev/learn/the-nodejs-events-module" >}}
{{< card "https://nodejs.dev/learn/the-nodejs-http-module" >}}
{{< card "https://nodejs.dev/learn/nodejs-buffers" >}}
{{< card "https://nodejs.dev/learn/nodejs-streams" >}}
{{< card "https://yarn.bootcss.com/docs/getting-started" >}}
{{< card "https://pnpm.io/zh/installation" >}}
{{< card "https://nodejs.dev/learn/accept-input-from-the-command-line-in-nodejs" >}}
{{< card "https://nodejs.dev/learn/the-npx-nodejs-package-runner" >}}
{{< card "https://nodejs.dev/learn/the-nodejs-event-loop" >}} {{< card "https://nodejs.dev/learn/understanding-process-nexttick" >}} {{< card "https://www.php.cn/js-tutorial-408369.html" >}}
{{< card "https://nodejs.dev/learn/javascript-asynchronous-programming-and-callbacks" >}} {{< card "https://nodejs.dev/learn/understanding-javascript-promises" >}} {{< card "https://nodejs.dev/learn/modern-asynchronous-javascript-with-async-and-await" >}} {{< card "https://nodejs.dev/learn/the-nodejs-event-emitter" >}}
{{< card "https://nodejs.dev/learn/build-an-http-server" >}} {{< card "https://nodejs.dev/learn/get-http-request-body-data-using-nodejs" >}}
{{< card "https://nodejs.dev/learn/making-http-requests-with-nodejs" >}}
{{< card "https://nodejs.dev/learn/nodejs-file-stats" >}} {{< card "https://nodejs.dev/learn/nodejs-file-paths" >}} {{< card "https://nodejs.dev/learn/reading-files-with-nodejs" >}} {{< card "https://nodejs.dev/learn/writing-files-with-nodejs" >}} {{< card "https://nodejs.dev/learn/working-with-folders-in-nodejs" >}}
{{< card "https://nodejs.dev/learn/how-to-log-an-object-in-nodejs" >}}
{{< card "https://github.com/i0natan/nodebestpractices/blob/master/README.chinese.md" >}}