我正在使用NodeJS的ExpressJS web框架。
使用ExpressJS的人把他们的环境(开发、生产、测试……)，他们的路线等放在app.js上。我认为这不是一个美好的方式，因为当你有一个大的应用程序，app.js太大了!
我想要这样的目录结构:
| my-application
| -- app.js
| -- config/
| -- environment.js
| -- routes.js
这是我的代码:
app.js
var express = require('express');
var app = module.exports = express.createServer();
require('./config/environment.js')(app, express);
require('./config/routes.js')(app);
app.listen(3000);
配置/ environment.js
module.exports = function(app, express){
app.configure(function() {
app.use(express.logger());
});
app.configure('development', function() {
app.use(express.errorHandler({
dumpExceptions: true,
showStack: true
}));
});
app.configure('production', function() {
app.use(express.errorHandler());
});
};
配置/ routes.js
module.exports = function(app) {
app.get('/', function(req, res) {
res.send('Hello world !');
});
};
我的代码工作得很好，我认为目录的结构很漂亮。然而，代码必须进行调整，我不确定它是否好/漂亮。
是更好地使用我的目录结构和调整代码或简单地使用一个文件(app.js)?
谢谢你的建议!
更新(2013-10-29):请参阅我的另一个答案，它有JavaScript而不是CoffeeScript的流行需求，以及一个样板github回购和一个广泛的自述me详细介绍了我对这个主题的最新建议。
配置
你做的很好。我喜欢在顶级配置中设置自己的配置名称空间。Coffee文件，具有这样的嵌套名称空间。
#Set the current environment to true in the env object
currentEnv = process.env.NODE_ENV or 'development'
exports.appName = "MyApp"
exports.env =
production: false
staging: false
test: false
development: false
exports.env[currentEnv] = true
exports.log =
path: __dirname + "/var/log/app_#{currentEnv}.log"
exports.server =
port: 9600
#In staging and production, listen loopback. nginx listens on the network.
ip: '127.0.0.1'
if currentEnv not in ['production', 'staging']
exports.enableTests = true
#Listen on all IPs in dev/test (for testing from other machines)
exports.server.ip = '0.0.0.0'
exports.db =
URL: "mongodb://localhost:27017/#{exports.appName.toLowerCase()}_#{currentEnv}"
这对于系统管理员编辑是友好的。然后当我需要一些东西时，比如DB连接信息，它
require('./config').db.URL
公路/加强一
我喜欢把我的路径留给我的控制器，并在app/controllers子目录中组织它们。然后我可以加载他们，让他们添加任何他们需要的路线。
在我的应用程序/服务器。我做的是:
[
'api'
'authorization'
'authentication'
'domains'
'users'
'stylesheets'
'javascripts'
'tests'
'sales'
].map (controllerName) ->
controller = require './controllers/' + controllerName
controller.setup app
我有这样的文件:
app/controllers/api.coffee
app/controllers/authorization.coffee
app/controllers/authentication.coffee
app/controllers/domains.coffee
例如在域控制器中，我有一个这样的设置函数。
exports.setup = (app) ->
controller = new exports.DomainController
route = '/domains'
app.post route, controller.create
app.put route, api.needId
app.delete route, api.needId
route = '/domains/:id'
app.put route, controller.loadDomain, controller.update
app.del route, controller.loadDomain, exports.delete
app.get route, controller.loadDomain, (req, res) ->
res.sendJSON req.domain, status.OK
的观点
在app/views中放置视图已经成为一种习惯。我是这样写的。
app/views/layout.jade
app/views/about.jade
app/views/user/EditUser.jade
app/views/domain/EditDomain.jade
静态文件
进入一个公共子目录。
Github/Semver/NPM
放一个自述文件。Md markdown文件在你的git回购根github。
放一个包裹。json文件，在你的NPM的git repo根目录中有一个语义版本号。
我最近把模块当成了独立的小应用。
|-- src
|--module1
|--module2
|--www
|--img
|--js
|--css
|--#.js
|--index.ejs
|--module3
|--www
|--bower_components
|--img
|--js
|--css
|--#.js
|--header.ejs
|--index.ejs
|--footer.ejs
现在对于任何模块路由(#.js)，视图(*.ejs)， js, css和资产都是相邻的。
子模块路由设置在父文件#.js中，有另外两行
router.use('/module2', opt_middleware_check, require('./module2/#'));
router.use(express.static(path.join(__dirname, 'www')));
这样甚至子模块也是可能的。
不要忘记将view设置为src目录
app.set('views', path.join(__dirname, 'src'));
这是我的大多数express项目目录结构的外观。
我通常使用express dirname来初始化项目，请原谅我的懒惰，但它非常灵活和可扩展。PS -你需要为此获取express-generator(对于那些正在寻找它的人来说，sudo npm install -g express-generator, sudo因为你正在全局安装它)
|-- bin
|-- www //what we start with "forever"
|-- bower_components
|-- models
|-- database.js
|-- model1.js //not this exact name ofcourse.
|-- .
|-- node_modules
|-- public
|-- images
|-- javascripts
|-- controllers
|-- directives
|-- services
|-- app.js
|-- init.js //contains config and used for initializing everything, I work with angular a lot.
|-- stylesheets
|-- routes
|-- some
|-- hierarchy
.
.
|-- views
|-- partials
|-- content
|-- .env
|-- .env.template
|-- app.js
|-- README.md
你一定想知道为什么是。env文件?因为他们工作!我在我的项目中使用了dotenv模块(最近很多)，而且它很有效!在app.js或www中弹出这两个语句
var dotenv = require('dotenv');
dotenv.config({path: path.join(__dirname + "/.env")});
另一行用于快速设置/bower_components以在资源/ext下提供静态内容
app.use('/ext', express.static(path.join(__dirname, 'bower_components')));
它可能适合那些希望同时使用Express和Angular的人，或者只需要表达而不需要javascript层次结构的人。
