ITPub博客

首页 > 数字化转型 > 其他 > SpringBoot项目结构+入门实战,新手也能快速写接口

SpringBoot项目结构+入门实战,新手也能快速写接口

其他 作者:TitanTrace 时间:2026-10-14 15:39:03 0 删除 编辑
很多新手入门SpringBoot,最头疼的两个问题:一是项目结构混乱,不知道该把代码放在哪个文件夹;二是看完理论,还是不会写接口,无从下手。

今天就抛开复杂理论,纯实战、手把手教大家:从零搭建SpringBoot项目,吃透标准项目结构,亲手写出第一个接口,全程复制粘贴就能用,新手也能快速上手!记得关注不迷路,后续持续分享Java8+SpringBoot实战干货~
先说明:本文基于 Java8+ SpringBoot 2.7.18(最稳定版本)开发,搭配IDEA和Maven,所有操作步骤清晰可追溯,实践可用,不用多余配置,跟着走就能成功。

一、前置准备(必看,避免踩坑)

在开始之前,确保你的开发环境已经准备好,新手直接照做即可,老开发者可以快速跳过:
JDK:必须是Java8(推荐1.8.0_301及以上版本),别用太高版本,避免兼容性问题(20年开发经验提醒:Java8是企业级开发最主流、最稳定的版本,绝大多数公司都在使用);
开发工具:IntelliJ IDEA(推荐2021-2023版本,社区版足够用,不用破解);
构建工具:Maven(3.6+版本),IDEA自带,无需额外安装,只需配置国内镜像(加快依赖下载速度);
接口测试工具:Postman(免费,用于测试我们写的接口,也可以用浏览器替代简单接口)。
环境检查:打开CMD,输入 java -version 和 mvn -version,能正常显示版本号,就说明环境没问题。

二、SpringBoot标准项目结构(核心,必吃透)

很多新手写项目,代码乱堆乱放,后期维护起来比登天。SpringBoot的核心思想是“约定大于配置”,它有一套标准的项目结构,只要跟着这个结构来,不管是自己开发还是团队协作,都能一目了然。
先上完整的标准项目结构(复制到IDEA中,直接对应创建即可),每个文件夹的作用都标注得清清楚楚,新手不用死记硬背,用多了自然就记住了:
    src/├── main/│   ├── java/│   │   └── com/example/springbootdemo/  # 你的包名(自定义,建议用“公司域名.项目名”)│   │       ├── SpringbootDemoApplication.java  # 项目主启动类(核心,不能删、不能改名字)│   │       ├── controller/  # 控制器层:接收前端请求,返回响应(专门写接口的地方)│   │       ├── service/     # 业务逻辑层:处理核心业务(控制器调用service,不直接操作数据)│   │       │   └── impl/    # service实现类:具体的业务逻辑代码│   │       ├── entity/      # 实体类:对应数据库表(或简单的返回对象)│   │       ├── dto/         # 数据传输对象:接收前端参数、返回给前端的封装对象│   │       ├── config/      # 配置类:自定义配置(如跨域、拦截器等,入门暂时不用)│   │       └── util/        # 工具类:通用方法(如日期、字符串工具,入门暂时不用)│   └── resources/           # 资源文件夹(核心)│       ├── application.yml  # 主配置文件(重中之重,配置端口、数据库等)│       ├── static/          # 静态资源:图片、CSS、JS等(前端用,后端接口开发暂时不用)│       └── templates/       # 模板文件:HTML页面(前后端分离项目不用,入门暂时不用)└── test/                    # 测试类文件夹:测试接口、业务逻辑(入门暂时不用)└── pom.xml                  # Maven依赖配置文件(管理项目所需的jar包)

    关键文件夹/文件详解(新手重点看)

    主启动类(SpringbootDemoApplication.java):项目的入口,只要运行这个类,SpringBoot项目就会启动,自带内嵌Tomcat服务器,不用手动配置Tomcat,这也是SpringBoot的核心优势之一。
    controller层:专门写接口的地方,前端请求会先到这里,我们今天的实战重点就是这里。
    application.yml:最核心的配置文件,比如配置项目端口、数据库连接、日志级别等,入门阶段只需要配置端口即可。
    pom.xml:Maven依赖管理,我们需要什么功能,就添加对应的依赖,SpringBoot会自动下载jar包,不用手动导入。
    老开发提醒:包名一定要规范,不要用中文、数字开头;核心文件(主启动类、配置文件)不要随意改名、删除,否则项目会启动失败。

    三、手把手实战:从零搭建项目+写第一个接口

    这部分是重点,全程实操,每一步都有截图级说明,新手跟着做,5分钟就能写出第一个可访问的接口,成就感拉满!

    步骤1:创建SpringBoot项目(IDEA可视化操作)

    打开IDEA,点击「File」→「New」→「Project」,选择「Spring Initializr」(IDEA自带,不用额外安装),点击「Next」;
    填写项目基本信息(新手直接照填,后期可修改):
    点击「Next」,选择依赖(入门只需要一个核心依赖,别多选):
    点击「Next」,选择项目保存路径,点击「Finish」,IDEA会自动下载依赖,生成标准项目结构(第一次下载依赖可能较慢,耐心等待,配置国内镜像会快很多)。
    等待1-2分钟,项目创建完成,此时IDEA左侧会显示我们刚才说的标准项目结构,没有报错,就说明创建成功了。

    步骤2:完善项目结构,创建核心文件夹

    项目创建后,只有主启动类和默认的application.properties配置文件,我们需要手动创建核心文件夹和修改配置文件:
    在「com.example.springbootdemo」包下,依次创建「controller」、「service」、「entity」、「dto」四个文件夹(右键包名→New→Package,输入文件夹名即可);
    将默认的「application.properties」配置文件,重命名为「application.yml」(右键文件→Refactor→Rename,yml格式更简洁,开发中更常用);
    配置application.yml(入门只配置端口,避免端口冲突),复制以下代码粘贴到文件中:
      server:  port: 8080  项目端口,默认8080,若被占用可修改(比如8081)spring:  application:    name: springboot-demo  # 项目名称,自定义

      步骤3:写第一个接口(核心实战,复制粘贴即可)

      接口写在controller层,我们创建一个「HelloController」,写一个简单的GET接口,实现“访问接口,返回提示信息”的功能,全程不用写复杂逻辑。
      右键「controller」文件夹→New→Java Class,类名改为「HelloController」,点击确定;
      复制以下代码,粘贴到HelloController中(注释已经写清楚,新手可以看懂每一行的作用,注意确保类名与文件名一致,均为HelloController):
        package com.example.springbootdemo.controller;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RestController;// @RestController:标识这个类是控制器,并且所有方法的返回值都会转为JSON(接口开发必加)@RestController// @RequestMapping:定义接口的统一前缀,所有接口都会带上“/api”,避免接口路径冲突@RequestMapping("/api")public class HelloController {    // @GetMapping:定义接口的请求方式为GET,接口路径为“/hello”(完整路径:http://localhost:8080/api/hello)    @GetMapping("/hello")    public String hello() {        // 接口返回值,前端访问后会看到这句话        return "恭喜你!SpringBoot接口开发入门成功,我是20年Java8老开发,关注我,后续干货不断~";    }}

        步骤4:启动项目,测试接口(验证成果)

        这一步最关键,启动项目,测试我们写的接口,看是否能正常访问。
        找到主启动类「SpringbootDemoApplication.java」,右键→Run,启动项目;
        启动成功的标志:IDEA控制台出现「Started SpringbootDemoApplication in xxx seconds」(没有报错,只有INFO日志),说明内嵌Tomcat启动成功,项目正常运行;
        测试接口(两种方式,新手任选一种):
        恭喜!到这里,你已经成功搭建了SpringBoot项目,并且写出了第一个可访问的接口,已经迈出了SpringBoot入门的关键一步!

        四、进阶实战:写一个带参数的接口(实战常用)

        上面的接口是固定返回值,实际开发中,接口大多需要接收前端参数,返回对应的数据。我们再写一个带参数的GET接口,比如“根据用户名,返回欢迎信息”,还是复制粘贴即可。
        在HelloController中,新增一个接口方法,代码如下(新增在hello()方法下方即可):
          // 带参数的GET接口,接收前端传递的“username”参数@GetMapping("/welcome")// @RequestParam:接收GET请求的参数,required=false表示参数非必填,defaultValue表示默认值public String welcome(        @RequestParam(value = "username", required = false, defaultValue = "新手") String username) {    // 拼接参数,返回欢迎信息    return "欢迎你," + username + "!你已经掌握了SpringBoot带参数接口的开发,继续加油~";}
          重启项目(修改代码后,必须重启项目才能生效,操作方式:右键主启动类→Restart);
          测试接口:
          老开发提醒:实际开发中,参数校验很重要,比如用户名不能为空、长度限制等,后续会分享参数校验的实战技巧,关注不迷路!

          五、常见问题排查(新手必看,避免踩坑)

          新手操作过程中,可能会遇到一些问题,这里整理了3个最常见的问题,以及解决方案,帮你快速排查:
          项目启动失败,提示“Port 8080 was already in use”:端口被占用,修改application.yml中的port,比如改为8081,重启项目即可;
          访问接口提示“404 Not Found”:检查接口路径是否正确(比如少写了/api前缀)、控制器类上是否加了@RestController注解、项目是否正常启动;
          依赖下载失败,IDEA提示“Cannot resolve dependency”:配置Maven国内镜像,重新刷新Maven(右键pom.xml→Maven→Reload Project)。

          六、总结与后续规划

          今天的实战内容,已经覆盖了SpringBoot入门的核心:标准项目结构+简单接口开发,全程实操,没有复杂理论,新手跟着做,就能快速上手。
          SpringBoot入门不要贪多,先吃透项目结构,再慢慢练接口,从简单到复杂,逐步积累。


          来自 “ ITPUB博客 ” ,链接:https://blog.itpub.net/70051357/viewspace-3185580/ ,如需转载,请注明出处,否则将追究法律责任。

          上一篇: 没有了~
          下一篇: 没有了~
          请登录后发表评论 登录
          全部评论

          注册时间:2022-04-11

          • 博文量
            1
          • 访问量
            913