Documentation

A good document is like an intriguing story.

初始化工程

我们将通过一个简单的 Demo 来阐述 龙晶( Dragonshard ) 的功能,在此之前,我们假设您已经:

  • 拥有 Java8 开发环境以及相应 IDE ( IntelliJ IDEA )
  • 拥有可用的 MySQL5/6 开发环境
  • 熟悉 Spring Boot
  • 熟悉 Maven ( 3.3.9+ )

这里仅使用单一数据源演示。
创建Schema并在其下新增表:sys_role
对应脚本如下:

                        Copy
                        
CREATE SCHEMA IF NOT EXISTS `dragonshard_sample_daenerys`
  DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_bin;

USE `dragonshard_sample_daenerys`;

-- ----------------------------
--  Table structure for `sys_role`
-- ----------------------------
DROP TABLE IF EXISTS `sys_role`;
CREATE TABLE `sys_role`
(
  `id`            bigint UNSIGNED AUTO_INCREMENT NOT NULL,
  `role_name`     varchar(64)                    NOT NULL COMMENT '角色名称',
  `create_time`   datetime(3)                    NOT NULL COMMENT '创建时间',
  `modified_time` datetime(3)                    NOT NULL COMMENT '修改时间',
  `remark`        varchar(128) DEFAULT NULL COMMENT '备注',
  PRIMARY KEY (`id`)
) ENGINE = InnoDB
  COMMENT ='角色表';

-- ----------------------------
--  Records of `sys_role`
-- ----------------------------
BEGIN;
delete from sys_role where id > 0;
INSERT INTO `sys_role`
VALUES (1, 'super-admin', '2018-11-12 15:59:43', '2018-11-12 15:59:47', 'super-admin'),
       (2, 'admin-1', '2018-11-12 16:00:17', '2018-11-12 16:00:19', 'admin-1'),
       (3, 'admin-2', '2018-11-12 16:00:18', '2018-11-12 16:00:20', 'admin-2'),
       (4, 'admin-3', '2018-11-12 16:00:21', '2018-11-12 16:00:22', 'admin-3');
COMMIT;
                        
                    

生成代码

创建项目可以通过以下方式:

  • IDE创建。
  • 使用我们为您提供的 CodeGenerator Online 功能。
这里我们以第二种为例,点击下面链接会在新窗口打开
CodeGenerator Online

输入项目基本信息

项目名称( ProjectName ) : 相当于pom.xml文件中的 artifactId,输入"daenerys"。

包路径( BasePackagePath ) : 相当于pom.xml文件中的 groupId,输入"net.dragonshard"。

下载

点击 "确定&下载",会以zip格式打包并下载,文件名为 daenerys.zip。

配置

加载项目

daenerys.zip解压,并用IntelliJ IDEA打开: File > Open... > 选择解压后的 daenerys 文件夹

生成基础类

1.打开 net.dragonshard.daenerys.generator.CodeGenerator 类,修改里面的数据库连接信息。

2.运行main(),自动生成entitymapperservicecontroller

编码

在 net.dragonshard.daenerys.controller.RoleController 中写一个简单的 RESTful 接口。

                        Copy
                        
private IRoleService roleService;

@GetMapping("/{id}")
public ResponseEntity<Result<Role>> get(@PathVariable("id") Long id) {
    Role role = roleService.getById(id);
    return success(role);
}
                        
                    

然后在 RoleController 类上增加@AllArgsConstructor注解。

最后,还要修改 application-local.yml 文件中的数据库连接信息。

运行 net.dragonshard.daenerys.Application。

开始使用

打开 Postman,请求路径为http://localhost:21001/v1/api/role/1

以上就是一个简单 Demo 的演示,不要走开,后面功能更精彩。