npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

node-app-core

v1.0.3

Published

node.js application skeleton

Downloads

9

Readme

node.js 应用程序核心

Npm version

node.js 非常便于开发微服务的项目,npm 不乏针对具体服务场景的框架和类库,但非常缺乏将 node.js 的应用程序的启动、目录结构组织成一个有效的、可复用的架构。

这并不是一件易于实现的事情,毕竟事实上每个 node.js 的应用程序环境千差万别。

该类库也只基于自己多年开发 node.js 微服务所涉及的经验,排除应用中所需的具体类库,只针对 app 的初始化、启动。

安装说明

yarn add node-app-core
npm install node-app-core --save

使用说明

目前我们将应用程序的启动,界定为三个阶段:

  1. 应用程序实例化(new App)阶段。
  2. 加载应用程序的环境变量(initEnv)阶段 —— 指当前运行模式,附加的自定义配置文件等。
  3. 应用程序正式启动(bootstrap)阶段 —— 根据环境变量,生成对应的配置文件,并加载配置到应用程序的属性中。

理论上,会是如下的流程:

const AppCore = require('node-app-core');

const appRoot = 'any where'; // 如果不指定,默认为 process.cwd()
const appOptions = { // 应用程序的启动配置参数,以下列举为默认值
    envFile             : '.env', // 默认的环境变量文件,基于 appRoot ,可以指定为绝对路径
    configDir           : 'config', // 默认的配置路径,基于 appRoot ,可以指定为绝对路径
    isAppendCustomConfig: true, // 是否允许追加自定义配置文件
    configFiles         : ['common.json'], // 默认要加载的配置文件
    // 还有一个 mergeOptions ,是决定 app 的 merge 方法的逻辑,请参考 npm/deepmerge 
}; 

const app = new AppCore(appRoot, appOptions);

app.initEnv(); // 这一步骤可以省略,将包含在 bootstarp 中
// 输出环境变量的内容
// console.log(app.envVars) 
// 输出当前环境名称
// console.log(app.env) 

app.bootstrap();
// console.log(app.config) 

而实际上在项目中,推荐的做法是:

// app.js
const AppCore = require('node-app-skeleton');

class MyWebServiceApp extends AppCore {

    onConstructor() {
        // 应用程序实例化时
    }
    
    onBootstrap() {
        // 应用程序启动时
    }
}

const globalApp = new MyWebServiceApp;
globalApp.bootstrap();

module.exports = globalApp;

在其他的应用程序文件中:

const app = require('./app.js');

// ....