专栏首页Bug生活2048Spring Boot学习笔记(四)构建RESTful API标准工程实例

Spring Boot学习笔记(四)构建RESTful API标准工程实例

本文主要记录搭建RESTful API标准工程,包含比较推荐的工程结构,掌握一些基本注解,并引入Swagger

新建一个项目

通过`Spring Initializr`创建工程,选择所需要的jar包,如下图:

工程结构

Spring Boot框架对工程结构并没有什么特殊的限制,我这边基本按照网上主流和自己一些喜好进行划分,供参考:

代码层结构:

  • 前端控制器(Controller): com.xxx.controller
  • 数据服务层(Service): com.xxx.service
  • 实体(Entity)与数据访问层(Repository): com.xxx.domain
  • 公共方法及工具类: com.xxx.common

资源文件的结构:

  • 配置文件: src/main/resources/config
  • 静态文件: src/main/resources/static
  • 模板: src/main/resources/templates

编写第一个服务

`controller`下新建类`HelloController`,相关代码做了简单的注释,如下:

//相当于 @Controller + @ResponseBody

//该注解 方法method 返回类型是String时候则返回string,返回对象时候则讲json_encode 该对象的json字符串

@RestController

public class HelloController {

//该注解mapping指定路由

@RequestMapping(value = "/hello",method = RequestMethod.GET)

public String SayHello() {

return "Hello Spring Boot";

}

}

编写到这里,已经可以直接编译运行了,这里值得注意的是被`@SpringBootApplication`注解的启动类一定要放在所有的RestController的根路径的package下,@SpringBootApplication只会扫描@SpringBootApplication注解标记类包下及其子包的类,如果不放在根路径下,可以指定下:`@SpringBootApplication(scanBasePackages = "com.example.api_demo")`

无需配置Tomcat,直接启动,输入对应的地址可看到结果:

增加service层

在搭建了基础应用的基础上,我们增加service层抽离控制层和业务层代码。

`service`下新增`HelloService``HelloServiceImpl`两个类,代码如下:

//业务层接口:HelloService

public interface HelloService {

public String sayHello();

}

//接口实现:HelloServiceImpl

@Service

public class HelloServiceImpl implements HelloService{

@Override

public String sayHello()

{

return "Hello Spring Boot";

}

}

这样,简单的拆分就完成了。

引入Swagger

Swagger是什么大家自行百度,对于Restful API来说,Swagger绝对是它的好基友。

首先引入对应的jar包,在`pom.xml`加入:

<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>

新增类`Swagger2.java`,代码如下:

@Configuration

@EnableSwagger2

public class Swagger2 {

@Bean

public Docket createRestApi() {

return new Docket(DocumentationType.SWAGGER_2)

.apiInfo(apiInfo())

.select() .apis(RequestHandlerSelectors.basePackage("com.example.api_demo.controller"))

.paths(PathSelectors.any())

.build();

}

private ApiInfo apiInfo() {

return new ApiInfoBuilder()

.title("测试文档")

.description("这里是一段描述")

.termsOfServiceUrl("http://www.bug2048.com/")

.version("1.0")

.build();

}

}

到这里,Swagger就算配置完成了,接下来就是要添加文档内容了,修改之前的`HelloController`之后,直接编译运行,通过`/swagger-ui.html`就能看到效果

@ApiOperation(value="增加Service层输出Hello", notes="这是第二个demo")

@RequestMapping(value = "/hello",method = RequestMethod.GET)

public String sayHello()

{

return helloService.sayHello();

}

至此,简单的框架算是完成了,后面就可以逐步完善,包括接入日志,数据库等等,后面会持续更新。

总结

基于Spring Boot构建RESTful API相对来说还是比较便捷的,其中注解使得代码更加简洁,本次用到注解再汇总下,有时间的话可以深入理解下其背后的原理:

  • @SpringBootApplication: 申明让spring boot自动给程序进行必要的配置。
  • @RestController:REST风格的控制器
  • @RequestMapping:提供路由信息,负责URL到Controller中的具体函数的映射
  • @Service:一般用于修饰service层的组件
  • @Autowired: 自动导入依赖的bean

本文分享自微信公众号 - Bug生活2048(BugLife2048),作者:可爱的

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2018-02-25

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • Spring Boot学习笔记(五)整合MyBatis实现数据库访问

    这里主要依赖两个,一个是连接MySql的`mysql-connector-java`,还一个是SpringBoot整合MyBatis的核心依赖`mybatis-...

    Bug生活2048
  • 基于云开发的小程序海报功能的实现

    其实在最早之前的小程序中已经实现了一次,具体可以参考利用云开发优化博客小程序(三)——生成海报功能,主要还是使用原生的cavans进行组装,原本想代码copy过...

    Bug生活2048
  • 免费的对象存储——七牛云还是腾讯云

    在小程序生成海报时,需要将文章的头图下载到本地,开发过小程序的都知道小程序在进行网络通信时候只支持HTTPS请求。

    Bug生活2048
  • 027.掌握Service-Ingress使用

    对于基于HTTP的服务来说,不同的URL地址经常对应到不同的后端服务(RS)或者虚拟服务器( Virtual Host),这些应用层的转发机制仅通过Kubern...

    木二
  • 【Java框架型项目从入门到装逼】第一节 - Spring框架 IOC的丧心病狂解说,来一波神的视角

    剽悍一小兔
  • NDK--利用FFmpeg进行安卓原生绘制播放

    aruba
  • 12.1 LNMP架构介绍

    LNMP架构介绍目录概要 和LAMP不同的是,提供web服务的是Nginx 并且php是作为一个独立服务存在的,这个服务叫做php-fpm Nginx直接处理静...

    运维小白
  • Android 高仿微信发朋友圈浏览图片效果

    版权声明:本文为博主原创文章,转载请标明出处。 https://blog.csdn.net/lyhhj/article/details/50...

    Hankkin
  • 使用Dropwizard搭建一个Hello World

    官方例子中main方法写在Application类中,我这里将其提出来了,方便大家理解。

    cn華少
  • 18888元秒下的域名sdhlx.com已建站

    去年,有一枚五声母域名sdhlx.com以一口价18888元被秒走。近段时间该域名已被青岛海利信电子商务有限公司拿去建站了。

    躲在树上的域小名

扫码关注云+社区

领取腾讯云代金券