我们每做一个新项目，通常都是从另一个项目把代码拷贝过来，然后在其上做开发。但是这种模式的一个比较大的问题就是会有很多上个项目的遗留代码。因此，开发一个公共的应用骨架系统，在开始其他新项目时，从这个骨架系统开始开发，是一个很好的选择。
我们首先需要创建一个SpringBoot工程，我们可以使用：https://start.spring.io/
如下所所：
上图中比较关键的是从页面右侧“Add Dependencies”按钮弹出的列表中选择“Spring Web”。网站上的工具会生成一个基本的SpringBoot工程，并自动将zip文件下载到本地。
将该文件解压，以idea community版本打开（也可以使用商业版，但是该版本是收费版，出于尊重知识产权的原因，使用免费的社区版）。
我们首先将系统自带的src/main/resources下面的application.properties文件删除，添加application.yaml文件，添加如下内容：
server:
port: ${port:2208}
spring:
application:
name: first-service
logging:
pattern:
console: "%d{HH:mm:ss.SSS} %-5level %logger{36} - %msg%n"
file: "%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n"
level:
org.springframework.web: DEBUG
file: app.log
下面我们以Person对象的增、删、改、查操作为例，创建一个REST风格的API。
我们首先在repository包中创建Person对象：
public class Person {
private Long personId;
private String firstName;
private String lastName;
private int age;
// getter and setters
//......
}
接下来我们来创建REST服务端，在controller包中创建DemoController类：
@RestController
@RequestMapping("/person")
public class DemoController {
private List<Person> persons = new ArrayList<>();
@GetMapping
public List<Person> findAll() {
return persons;
}
@GetMapping("/{personId}")
public Person findById(@PathVariable("personId") Long personId,
HttpServletRequest request) {
String mode = request.getParameter("mode");
System.out.println("mode=" + mode + "!");
return persons.stream().filter(item -> item.getPersonId().equals(personId)).findFirst().get();
}
@PostMapping
public Person add(@RequestBody Person p) {
p.setPersonId((long)(persons.size()+1));
persons.add(p);
return p;
}
@DeleteMapping("/{personId}")
public void delete(@PathVariable("personId") Long personId) {
List<Person> ps = persons.stream().filter(item -> item.getPersonId().
equals(personId)).collect(Collectors.toList());
persons.removeAll(ps);
}
@PutMapping
public void update(@RequestBody Person p) {
Optional<Person> person = persons.stream().filter(item -> item.getPersonId().
equals(p.getPersonId())).findFirst();
person.ifPresent(po->persons.set(persons.indexOf(po), p));
}
}
由于用到了Jdk8以后的一些特性，这里稍做一些解释：
我们下面需要对REST服务进行测试，我们可以通过PostMan来进行测试，但是在这里，我们将采用Swagger来进行测试。这样做主要好处是可以同时生成REST服务的文档。
我们首先在项目根目录下的pom.xml中添加如下内容：
<!-- 开始：添加Swagger支持 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.7.0</version> </dependency> <!-- 结束：添加Swagger支持 --> <!-- 开始：读取maven pox.xml文件 --> <dependency> <groupId>org.apache.maven</groupId> <artifactId>maven-model</artifactId> <version>3.0</version> </dependency> <!-- 结束：读取maven pox.xml文件 -->
同时给应用类StpApplication添加如下标注：
@EnableSwagger2
@SpringBootApplication
public class StpApplication {
......
@Bean
public Docket api() throws IOException, XmlPullParserException {
MavenXpp3Reader reader = new MavenXpp3Reader();
Model model = reader.read(new FileReader("pom.xml"));
ApiInfoBuilder builder = new ApiInfoBuilder()
.title("智慧交通平台")
.description("智慧交通平台API接口文档")
.version(model.getVersion())
.contact(new Contact("最老程序员", "www.abc.com", "ua@"));
return new Docket(DocumentationType.SWAGGER_2).select().
apis(RequestHandlerSelectors.basePackage("com.zhuanjingkj.stp.demo.controller"))
.paths(PathSelectors.any()).build()
.apiInfo(builder.build());
}
}
就是添加@EnableSwagger2标注信息。在浏览器中输入如下地址：http://localhost:2208/swagger-ui.html
会显示如下图所示页面：
我们可以点击进入对应的接口，可以看到接口的调用方法，同时可以填写真实的数据，对接口进行测试。
