Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/notadd/magnus
magnus
https://github.com/notadd/magnus
graphql grpc orm protobuf typeorm
Last synced: about 2 months ago
JSON representation
magnus
- Host: GitHub
- URL: https://github.com/notadd/magnus
- Owner: notadd
- Archived: true
- Created: 2019-08-07T03:51:25.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-10-20T02:13:11.000Z (almost 4 years ago)
- Last Synced: 2024-05-22T05:40:52.465Z (4 months ago)
- Topics: graphql, grpc, orm, protobuf, typeorm
- Language: TypeScript
- Size: 4.62 MB
- Stars: 11
- Watchers: 4
- Forks: 2
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-nestjs - Magnus
README
### 功能特点
- 可生成@nestjs/graphql相应接口的`.graphql`文件，无缝对接
- 可生成@nestjs/grpc相应的`.proto`文件，无缝对接
- 编译生成，打包更小，速度更快
- magnus去掉服务端，速度更快，更灵活!
- 程序自动维护graphql和proto文件，无缝对接nestjs
- 根据 Typescript 自动生成`.graphql`和`.proto`配置文件（灵活）
- 生成自动支持按条件搜索、分页、排序的增删改查
- 自动更新数据库结构
- 局域网内项目 proto 同步及接口文件自动生成，方便团队协作，可在不同电脑启动不同微服务
- 全面支持微服务架构
## install
```
npm install -g @notadd/magnus
```
## add magnus.json
```json
{
"prefix": "", // 前缀
"inputs": [// 输入
"demo/src/**/*.ts"
],
"output": "demo/config",// 输出
"assets": "demo/assets",// 静态资源
"debug": false,// 调试
"name": "demo",// 名称
"client": [//客户端
"demo/src/**/*.graphql"
],
"hasGrpc": true,// 是否提供grpc
"runner": {// magnus runner目录
"name": "runner",
"path": "../runner"
},// 定义文件
"types": "../../config/demo/magnus.server",
"def": "demo/assets/demo/magnus.server.graphql"// 定义graphql文件
}
```
## run magnus
```ts
magnus --watch 监听文件变化
magnus 单次运行
```
### orm
```ts
import { Magnus, MagnusBase, Mutation, Query, Where, Order } from '@notadd/magnus-core';
import { getRepository, SelectQueryBuilder, FindOperator, FindConditions } from 'typeorm';
import {
Department,
Role,
RoleGroup,
SafetyScoreLog,
SafetyScoreRule,
Station,
System,
SystemEvent,
SystemRight,
ToDoItem,
User,
UserLoginLog
} from '../entities';
import { PageLimit } from './types';
@Magnus({
entities: [
User,
System,
SystemEvent,
SystemRight,
Department,
Role,
Station,
ToDoItem,
RoleGroup,
UserLoginLog,
SafetyScoreLog,
SafetyScoreRule
]
})
export class Controller extends MagnusBase {
get repository() {
return getRepository(this.entity);
}
/**
* 没有就插入，有就更新
* @param entity 要保存的数据
*/
@Mutation()
async save(entity: T): Promise {
const item = this.repository.create(entity);
return await this.repository.save(item);
}
/**
* 插入数据
* @param entity 要插入的数据
*/
@Mutation()
async insert(entity: T): Promise {
const item = this.repository.create(entity);
const res = await this.repository.insert(item);
return item;
}
/**
* 通过指定条件获取一条数据
* @param entity 条件
*/
@Query()
async get(entity: Where): Promise {
const selectAndRelations = this.createSelectAndRelations();
const res = await this.repository.findOne({
where: entity,
select: selectAndRelations.select,
relations: selectAndRelations.relations
});
return res;
}
/**
* 通过制定条件获取一组数据
* @param entity 条件
*/
@Query()
async find(entity: Where, order: Order, limit: PageLimit = {
page: 1,
psize: 20
}): Promise {
const selectAndRelations = this.createSelectAndRelations();
const where = createWhere(entity);
const res = await this.repository.find({
select: selectAndRelations.select,
where,
relations: selectAndRelations.relations,
skip: (limit.page - 1) * limit.psize,
take: limit.psize,
order: order
});
return res;
}
/**
* 删除
* @param id 根据id删除
*/
@Query()
async delete(id: number): Promise {
const res = await this.repository.delete(id);
if (res) return true;
return false;
}
}
```
### 覆盖orm
```ts
@Magnus()
export class Controller2 extends MagnusBase {
tablename: string = 'User';
/**
* 覆盖Controller中的getUser，单独处理
**/
@Query()
getUser(): User {
return {
id: 1,
};
}
}
```
## 使用 编写client.graphql 自动生成对应client.ts文件函数
```graphql
query getUser($user: UserInput!){
getUser(entity: $user){
id,
nickname
}
}
```
```ts
import { getUser } from './client.ts'
getUser({id: 1}).then(res=>res.getUser).then(res=>({
id: res.id,
nickname: res.nickname
}))
```