1. 程式人生 > 實用技巧 >spring boot 學習筆記

spring boot 學習筆記

通過Spring Initializr建立工程,選擇所需要的jar包,如下圖:

程式碼層結構

  • 前端控制器(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";
    }
}

直接啟動,輸入對應的地址可看到結果:

增加service層

在搭建了基礎應用的基礎上,我們增加service層抽離控制層和業務層程式碼。

service下新增HelloServiceHelloServiceImpl兩個類,程式碼如下:

//業務層介面:HelloService
public interface HelloService {
    public String sayHello();
}

//介面實現:HelloServiceImpl
@Service
public class HelloServiceImpl  implements HelloService{
    @Override
    public String sayHello()
    {
        return "Hello Spring Boot";
    }
}

修改對應的controller程式碼:

@Autowired
private HelloService helloService;

@RequestMapping(value = "/hello",method = RequestMethod.GET)
public String sayHello()
{
    return helloService.sayHello();
}

引入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();
}