Spring Boot Hello World (restful接口)例子

时间:2023-01-03 10:11:28

Spring Boot 集成教程


本篇我们将用spring boot写一个hello world web应用,唯一功能是访问接口返回hello world字符串。在前后端分离的大趋势下,直接用java写页面的情况已经很少了,一般都是后端用java写接口,前端用JS(可用vue/react等框架)写页面,因此我们选择接口方式写hello world例子。

创建项目

打开Eclipse,如果还没有搭建开发环境,可参照 spring boot开发环境搭建(Eclipse)搭建,选择菜单:File -> New -> Project...,弹出“New Project”对话框,选择Spring Starter Project,如下图,点击Next:

Spring Boot Hello World (restful接口)例子

根据需要修改一些输入信息,点击Next:

Spring Boot Hello World (restful接口)例子

下面这个对话框用于自动生成依赖配置(pom.xml),在对话框中勾选Web(不能遗漏),点击 Finish,创建新项目

Spring Boot Hello World (restful接口)例子

如无意外,项目将会创建成功。

项目目录结构

Spring Boot Hello World (restful接口)例子

项目目录说明:

  • src - 源码目录
    • main - 代码
      • java - Java代码目录
      • resources - 配置文件等资源目录
    • test - 测试代码
  • target - 编译后的输出目录

项目根目录下的pom.xml文件就是maven的依赖包配置文件。

更新依赖包

新建项目,建议更新依赖包。如下图,在Eclipse左侧目录窗口,鼠标指向项目文件夹,点击右键弹出菜单,选择:Maven -> Update project...,弹出对话框中勾选我们的项目,开始更新。

Spring Boot Hello World (restful接口)例子

如要查看更新进度,可在Eclipse界面下方的进度窗口中查看:

Spring Boot Hello World (restful接口)例子

写代码

等依赖包更新完成后,添加HelloController.java文件。展开src目录,指向hello目录点击右键弹出菜单,选择:New -> File, 添加HelloController.java文件

Spring Boot Hello World (restful接口)例子

在HelloController.java中添加代码:

package com.qikegu.hello;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController; @RestController
public class HelloController { @RequestMapping(value="/hello", method=RequestMethod.GET)
public String hello() { return "Hello World!";
}
}

代码中有两个注解要解释一下:

  • RestController 这个注解表明这个控制类提供Restful接口
  • RequestMapping 这个注解映射url请求,此处的意思是:方法是Get,url路径是 /hello

注意:如要进一步理解这两个注解以及什么是Restful接口,可查看相关资料。

运行

Eclipse界面左侧,弹出项目右键菜单,选择:Run As -> Spring Boot App,运行程序:

Spring Boot Hello World (restful接口)例子

打开浏览器,访问:http://localhost:8080/hello (spring boot默认端口是8080)

Spring Boot Hello World (restful接口)例子

总结

完整代码