属于Node的Spring服务端框架 a2n

a2n

一套基于Spring设计理念开发的NodeJs服务端框架。

NPM Github

作为一名软件开发搬砖仔,今年年初毕业后找了一份前端开发的工作,技术栈主要是 Vue,虽然工作内容只有前端,但是自己也是懂一些后端。平时我比较倾向于用 Java Spring 来写接口,在深入学习 Spring 的设计理念之后,就想着自己也写一个实用的框架出来,但是 Java 出色的框架已经很多了,我也不是专业的 Java 工程师,所以选择了使用 Node 来开发一个服务端框架,对 Node 感兴趣的小伙伴可以前往 Github 或者 NPM 下载体验。

✨ 特性

  • 🌍 基于 NodeJs+Express 进行开发。
  • 🌈 采用了 Java 语言 Spring 框架的设计理念,实现了 Spring 中 AOP,IOC 等主要的功能。
  • ⚙️ 在体验 Spring 设计模式的同时,又可以使用 npm 强大的插件功能。
  • 🛡 使用 TypeScript 开发,提供完整的类型定义文件。
  • 📦 如果你曾经是一个Java程序员并且有一定的Js基础,那么可以以极低的学习成本使用a2n进行开发。

📦 搭建

  • 安装脚手架
bash 复制代码
npm install a2n-cli -g
  • 初始化项目基础代码环境
bash 复制代码
a2n-cli create <project-name>
  • 进入项目目录
bash 复制代码
cd <project-name>
  • 安装依赖
bash 复制代码
npm install
  • 启动服务
bash 复制代码
npm run dev
  • 打包
bash 复制代码
npm run build

🔨 项目结构

  • 配置文件 a2n.config.js
js 复制代码
module.exports = {
  // 组件扫描路径,该路径下的js,ts文件将会被容器扫描,默认src
  componentScan: 'src',
  // 服务启动端口号
  port: 8088,
  // 一些自定义的配置项
  datasource: {
    url: '123lll'
  }
}
  • 启动入口 main

main 目录下的文件为项目启动和打包相关的文件,start.ts 为入口文件,config 中为本地开发和打包时的 webpack 配置文件,由于本地开发环境需要实现代码热更新,因此将 webpack 配置文件进行拆分。

  • ts语言配置

通过根目录下的 tsconfig.json 配置ts语言能力。

🌈 如何使用

编写接口

ts 复制代码
import { Control, Get, Query, Post, Body, Put, Req, Res, Request, Response } from 'a2n';

/**
 * 使用@Control标记一个Class
 * Class下的@Get,@Post,@Delete,@Put方法都会被注册为接口,方法return的值作为接口返回值
 */
@Control("/user")
export default class UserControl{

  @Get("/get")
  get(@Query query: any, @Query("name") name: string){
    // 使用@Query注入url携带的参数,@Query("name")表示注入url参数中名称为name的参数
    return query.name
  }

  @Post("/post")
  get1(@Body body: any, @Body("name") name: string){
    // 使用@Body注入请求报文携带的参数,@Body("name")表示注入请求报文中名称为name的参数
    return body
  }

  @Put("/put")
  get1(@Req request: Request, @Res response: Response){
    // 使用@Req注入请求对象,@Res注入响应对象
    // 请求和响应对象使用参考express的Request、Response使用方法 https://nodejs.cn/express/4x/api/req/
  }

}
相关推荐
可以给我一百万吗27 分钟前
黑马Node.js全套入门教程,nodejs新教程含es6模块化+npm+express+webpack+promise等_ts对象笔记
npm·node.js·es6
ttod_qzstudio28 分钟前
TypeScript 配置全解析:tsconfig.json、tsconfig.app.json 与 tsconfig.node.json 的深度指南
typescript·node.js·json
engineer_why1 小时前
【elpis专栏】里程碑一:elpis-core 引擎的理解
node.js
Littlewith16 小时前
Node.js:创建第一个应用
服务器·开发语言·后端·学习·node.js
墨菲安全16 小时前
Node.js Windows下路径遍历漏洞
windows·node.js·路径遍历漏洞
码间舞16 小时前
【面试官】:NodeJs事件循环你了解多少?我笑了,让我喝口水慢慢给你说来......
后端·node.js
Komorebi_99991 天前
webpack相关
前端·webpack·node.js
半桶水专家1 天前
webpack和vite对比
前端·webpack·node.js
Q_Q19632884751 天前
python的抗洪救灾管理系统
开发语言·spring boot·python·django·flask·node.js·php
i小溪2 天前
Fanuc机床 CNC_STATINFO 方法返回值说明
物联网·node.js