一、创建SpringBoot工程
这里介绍一种通过spring官网的来创建springboot工程的方法。
首先输入网址 https://start.spring.io
选择Maven工程或者Gradle工程,这里选的是Gradle工程。
在serch for dependency输入web,即可完成基本的restful接口网关的功能。
如果要JPA或者oauth安全相关的组件,可以增加rest repository、spring security等相关组件依赖库,spring提供的配套组件还是很多的,基本涵盖了所有应用场合。
加入web组件后,点击下方的绿色按钮Generate Project即可创建一个springboot工程,并且自动下载到本地。
二、编译工程
这里我们用的是idea,注意项目生成的build.gradle文件中,默认写的是eclipse,
这会导致我们编译项目报错
这里需要把ecplise改成idea即可编译。
经过长时间的等待,编译终于完成。
feiyongdeMacBook-Pro:springboot_web feiyong$ gradle idea
Download https://repo.maven.apache.org/maven2/org/springframework/spring-webmvc/5.0.7.RELEASE/spring-webmvc-5.0.7.RELEASE.jar
Download https://repo.maven.apache.org/maven2/org/springframework/spring-aop/5.0.7.RELEASE/spring-aop-5.0.7.RELEASE.jar
Download
https://repo.maven.apache.org/maven2/org/apache/logging/log4j/log4j-to-slf4j/2.10.0/log4j-to-slf4j-2.10.0-sources.jar
...省略下载jar包...
Download https://repo.maven.apache.org/maven2/org/objenesis/objenesis/2.6/objenesis-2.6-sources.jar
> Task :idea
Generated IDEA project at file:///Users/feiyong/code/spring_boot/springboot_web/springboot_web.ipr
BUILD SUCCESSFUL in 43m 30s
4 actionable tasks: 4 executed
接下来直接双击工程名.ipr打开该工程就可以了。
三、工程结构介绍
发现自动创建了SpringbootWebApplication.java该类为springboot的启动类,相当于我们程序的main函数入口。
SpringBootApplication注解
所有的springboot application启动类都需要在类级别上加上@SpringBootApplication注解,其他参数不用任何调整,后续可以把一些初始化的动作放到该类中进行,目前本例中就不加其他的启动加载项了。这样一个api网关的架子就搭好了。
run as 这个文件,就可以启动我们的服务了
四、api基础服务
新建control包,新建类HttpDemoControl
get请求
package com.springboot.springboot_web.control;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
//@RestController注解能够使项目支持Rest
@RestController
@SpringBootApplication
//表示该controller类下所有的方法都公用的一级上下文根
@RequestMapping(value = "/springboot")
public class HttpDemoControl {
//http://127.0.0.1:8080/springboot/getUserByGet?userName=fei
//这里使用@RequestMapping注解表示该方法对应的二级上下文路径
@RequestMapping(value = "/getUserByGet", method = RequestMethod.GET)
String getUserByGet(@RequestParam(value = "userName") String userName){
return "Hello " + userName;
}
}
RequestMapping注解
表示请求的URL上下文路径,该路径不能重复,为了不重复,一般会在每个controller前面加一个一级上下文目录,具体路径参数放在value后面,在每个方法前加一个二级目录,这样可以有效的避免路径冲突。
另外,设置method为get来表示该请求为get请求,除了get、post还有put、delete等请求方式,都可以通过该参数设置。
RequestParam注解
通过url form形式提交的请求参数,那么必须使用@RequestParam注解来标示参数,通过value指定入参。
接口返回
这里return的返回值就是实际的接口返回
post请求(url form形式)
//通过RequestMethod.POST表示请求需要时POST方式
@RequestMapping(value = "/getUserByPost", method = RequestMethod.POST)
String getUserByPost(@RequestParam(value = "userName") String userName){
return "Hello " + userName;
}
post请求(json形式)
//在入参设置@RequestBody注解表示接收整个报文体,这里主要用在接收整个POST请求中的json报文体,
//目前主流的请求报文也都是JSON格式了,使用该注解就能够获取整个JSON报文体作为入参,使用JSON解析工具解析后获取具体参数
@RequestMapping(value = "/getUserByJson",method = RequestMethod.POST)
String getUserByJson(@RequestBody String data){
return "Json is " + data;
}
RequestBody标注
如果使用的请求报文是POST形势的JSON串,那么这里在入参的注解一定要使用@RequestBody,否则会报json解析错误。