来认识一下venus-init——一个让你仅需一个敕令最先Java开辟的敕令行东西

源代码地点: Github堆栈地点

小我网站：小我网站地点

媒介

不知道你是不是有过如许的阅历。不论你是甚么岗亭，前端也好，后端也罢，想去相识一下Java开辟究竟是甚么样的，它是不是真的跟传说中的一样。

因而你拿起键盘，用触控板 ? '' : 抄起鼠标'，最先了Java淌坑之旅。在一把梭的操纵以后，面临你搭建的情况，你陷入了深深的寻思，最先了吾日三省吾身的自我质疑中。这tm究竟哪儿错了？究竟哪儿在报错？这报错啥意思？

阅历了吾日三省吾身的沉思以后，你把鼠标挪动到了MacOS ? 左上角' : '右上角'，然后双手离开了键盘摒弃了操纵。嗯，方才甚么都没有发作。

若是你有相似的阅历（若是没有请给Java一个体面伪装你有过）,那末就来认识一下venus-init吧。

venus-init

它是甚么

venus-init是一个基于Node.js的敕令行东西。运用venus-init，只须要一个敕令，然后输入两个参数，就能够建立一个简朴的Spring Boot运用。而且初始化的demo项目中还会有一个名叫Hello的模块来资助你更好的明白这个项目。

在我还没有更新文档的情况下，npm上周下载量就突破了1000，不论是因为甚么原因，下错了也好，以为好用也好。谢谢大佬们的支撑。

怎样运用

怎么做呢？"He can do that with a snap of his fing..." 走错了片场不好意思。起首你须要运用npm install venus-init来装置它。然后只须要在敕令行输入以下的敕令。

venus init
# you can also do it like this
venus i

只需输入如许一个敕令，然后追随敕令行东西的指点，完成建立就ok了。

建立项目以后

完成上述步调以后，就会发如今键入敕令行的目次下，多个一个具有如许构造的目次。(这是我本身建立的demo项目，group和artifact都能够本身指定)

.
├── LICENSE
├── README.md
├── api
│   ├── pom.xml
│   └── src
│       └── main
│           ├── java
│           │   └── com
│           │       └── detectivehlh
│           │           └── demo
│           │               └── api
│           │                   ├── Application.java
│           │                   ├── config
│           │                   │   ├── DbConfig.java
│           │                   │   └── SwaggerConfig.java
│           │                   ├── controller
│           │                   │   └── HelloController.java
│           │                   ├── dao
│           │                   │   └── HelloMapper.java
│           │                   ├── dto
│           │                   │   └── HelloDTO.java
│           │                   ├── entity
│           │                   │   └── Hello.java
│           │                   └── service
│           │                       ├── HelloService.java
│           │                       └── impl
│           │                           └── HelloServiceImpl.java
│           └── resources
│               ├── application.yml
│               └── mapper
│                   └── HelloMapper.xml
└── pom.xml

个中我内置了一个Hello的模块供人人参考，经由过程这个模块置信人人能够更加速的熟习全部项目。全部项目的构造异常的清楚清楚明了。

总共有6个包，config用于寄存种种设置装备摆设，像swagger的设置装备摆设就放在这个包下面。

controller包是种种模块的掌握层，内里包含了项目一切的api。

dao中寄存了各个模块和数据库交互的mapper，值得注意的是，dao下只界说了接口，详细的sql则是放在了resources/mapper下。

dto中则是寄存了与前端交互的数据构造。简朴明白一下，数据库寄存的数据并非前端须要的数据，以是在查到数据以后须要对数据举行一次转换，再把转换好的数据返回给前端。

entity则是寄存了与数据库交互的数据构造。通常情况下是与数据库的字段一一对应的。

service包是各个模块的中心代码所处的为主。大批的营业都邑在这个包下。

Application则是项目的启动文件。

resources下的application.yml则是全部项目的设置装备摆设文件。能够在这里设置装备摆设项目的称号，数据库的设置装备摆设，以及mybatis的设置装备摆设，redis的设置装备摆设等等。

启动项目

发起运用IDEA来翻开这个项目，然后右键挪动到Application上，挑选Run Application便可看到运用运行在8080端口。

接下来，你只须要接见http://localhost:8080/hello，若是看到页面返回了以下信息，那末祝贺你，项目已胜利的启动了。

{
    "message": "Hello world",
    "createdAt": "current_timestamp"
}

检察项目的接口文档

运用venus-init初始化建立的项目会默许启用swagger文档，这是一个不须要你手写的api文档。swagger基于注解。只需你在关于的controller中写上了对应的注解，swagger就会自动的帮你天生API文档。

在项目胜利的启动以后，你只需接见[http://localhost:8080/swagger-ui.html就能够看到本身的项目中有哪些接口，每一个接口须要甚么参数了以及接口的返回值是甚么了。

怎样衔接数据库

初始化的项目一样也支撑mysql的jdbc衔接，同时在Hello模块中也完成的例子。

数据库信息

假定你有一个MySQL数据库，名字叫demo，地点是localhost，端口是3306，用户名和暗码都是root，那末你须要在application.yml中找到数据库设置装备摆设，将db_name换成你本身的数据库名也就是demo。然后重新启动项目，就能够直接连上你的数据库了。

若是你须要修正mysql的表名，则须要到HelloMapper.xml中，找到以下段落。