Spring Boot 構建 Restful API 和測試

gary-liu發表於2017-05-30

建立工程時已經選擇了 web 模組,所以可以使用 springmvc。

註解介紹

@Controller:修飾class,用來建立處理http請求的物件

@RestController:Spring4之後加入的註解,原來在@Controller中返回json需要@ResponseBody來配合,如果直接用@RestController替代@Controller就不需要再配置@ResponseBody,預設返回json格式。

controller 例子

這裡使用restful controller ,返回的內容為 json


@RestController
@RequestMapping(value="/users")
public class MyRestController {

    @RequestMapping(value="/{user}", method= RequestMethod.GET)
    public User getUser(@PathVariable Long user) {
        // ...
        User user1 = new User();
        user1.setId(user);
        user1.setName("liu");
        user1.setAge(20);
        return user1;
    }

    @RequestMapping(value="/{user}", method=RequestMethod.DELETE)
    public User deleteUser(@PathVariable Long user) {
        // ...
        User user1 = new User();
        user1.setId(user);
        user1.setName("liu");
        return user1;
    }

}

單元測試

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class MyRestControllerTest {

    @Autowired
    private TestRestTemplate restTemplate;

    @Autowired
    private MyRestController myRestController;

    @Test
    public void userTest() {

        User user1 = restTemplate.getForObject("/users/2", User.class);
        System.out.println(user1.toString());

        User user = this.myRestController.getUser(1L);
        System.out.println(user.toString());

    }
}

執行程式

啟動 web 應用,執行命令

mvn spring-boot:run

在瀏覽器上輸入 http://localhost:8080/users/1 可以看到返回結果

{"id":1,"name":"liu","age":20}

專案示例:https://github.com/lzx2011/springBootPractice

參考資料

https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-testing.html

相關文章