Spring Boot GitHub 教程：零基础快速上手 – wiki大全

作者： /

Spring Boot GitHub 教程：零基础快速上手

在现代软件开发中，Spring Boot 凭借其“约定优于配置”的理念，成为了 Java 开发者构建微服务和 Web 应用的首选框架。同时，GitHub 作为全球最大的代码托管平台，是团队协作、版本控制和开源项目管理的基石。

本教程旨在帮助零基础的开发者快速掌握如何将 Spring Boot 项目与 GitHub 有效结合，实现从项目创建到版本控制的全过程。

为什么选择 Spring Boot 和 GitHub？

  • Spring Boot: 简化 Spring 应用的初始搭建以及开发过程。开箱即用，快速启动，无需繁琐的 XML 配置。
  • GitHub: 提供强大的分布式版本控制系统 Git 的托管服务。方便代码共享、团队协作、历史版本追溯和冲突管理。

前提条件

在开始之前，请确保您的开发环境中已安装以下工具：

  1. Java Development Kit (JDK): 推荐使用 OpenJDK 8 或更高版本。
  2. Maven 或 Gradle: Spring Boot 项目的构建工具。本教程将以 Maven 为例。
  3. Git: 分布式版本控制系统。
  4. GitHub 账号: 如果您还没有，请前往 github.com 注册一个。
  5. 集成开发环境 (IDE): 推荐使用 IntelliJ IDEA, Eclipse 或 VS Code。

步骤一：创建 Spring Boot 项目

我们将使用 Spring Initializr (一个 Spring Boot 项目生成器) 来快速创建一个项目。

  1. 访问 Spring Initializr: 打开浏览器，访问 start.spring.io。
  2. 配置项目信息:
    • Project: 选择 Maven Project。
    • Language: 选择 Java。
    • Spring Boot: 选择一个稳定的最新版本（例如 3.2.x）。
    • Project Metadata:
      • Group: com.example (或您自己的组织名称)
      • Artifact: myfirstspringbootapp (您的项目名称)
      • Name: myfirstspringbootapp
      • Description: Demo project for Spring Boot
      • Package name: com.example.myfirstspringbootapp
      • Packaging: Jar
      • Java: 选择您安装的 Java 版本 (例如 17 或 21)。
    • Dependencies: 点击 ADD DEPENDENCIES 按钮，添加 Spring Web。这个依赖将允许我们创建 RESTful Web 服务。
  3. 生成项目: 点击 GENERATE 按钮，将项目以 .zip 文件的形式下载到本地。
  4. 解压并导入 IDE: 将下载的 .zip 文件解压到您的工作目录。然后，打开您的 IDE (例如 IntelliJ IDEA)，选择 Open 或 Import Project，导航到解压后的项目文件夹，并将其导入。

步骤二：编写一个简单的 RESTful API

现在，我们将在 Spring Boot 项目中编写一个简单的“Hello World” RESTful 接口。

  1. 创建 Controller:
    在 src/main/java/com/example/myfirstspringbootapp 目录下，创建一个名为 HelloController.java 的新文件。

    “`java
    package com.example.myfirstspringbootapp;

    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;

    @RestController
    public class HelloController {

    @GetMapping("/hello")
public String sayHello() {
    return "Hello, Spring Boot!";
}

    }
    ``
    *    @RestController: 这是一个方便的注解，它结合了@Controller和@ResponseBody，表示该类是一个 REST 控制器，其方法的返回值将直接作为 HTTP 响应体。
    *    @GetMapping(“/hello”): 将 HTTP GET 请求映射到/hello路径到sayHello()` 方法。

  2. 运行 Spring Boot 应用:
    在 IDE 中找到 MyfirstspringbootappApplication.java 文件（Spring Boot 的主启动类），右键点击并选择 Run 'MyfirstspringbootappApplication.main()'。

    当您看到控制台输出类似 Started MyfirstspringbootappApplication in X.XXX seconds (process running for Y.YYY) 的信息时，表示应用已成功启动。默认情况下，Spring Boot 应用会在 8080 端口运行。

  3. 测试 API:
    打开您的浏览器或使用 Postman/curl 等工具，访问 http://localhost:8080/hello。
    您应该会看到页面显示 Hello, Spring Boot!。

步骤三：初始化 Git 仓库并管理本地代码

现在，我们将把您的 Spring Boot 项目纳入 Git 的版本控制之下。

  1. 打开终端/命令行: 导航到您的项目根目录 (myfirstspringbootapp)。

    bash
    cd myfirstspringbootapp

  2. 初始化 Git 仓库:
    bash
    git init
    这会在您的项目目录中创建一个 .git 隐藏文件夹，表示这是一个 Git 仓库。

  3. 配置 .gitignore 文件:
    不是所有的文件都需要上传到 GitHub。例如，编译生成的类文件、IDE 配置文件、依赖包等都应该被忽略。
    在项目根目录创建或编辑 .gitignore 文件：

    “`

    Maven

    /target/

    IDE

    .idea/
    *.iml
    .vscode/

    Logs

    *.log
    logs/

    Spring Boot

    .jar
    .war
    /build/

    OS

    .DS_Store
    Thumbs.db
    ``
    Spring Initializr 默认已经生成了一个比较完善的    .gitignore` 文件，您可以检查并根据需要添加。

  4. 将所有文件添加到暂存区:
    bash
    git add .
    . 表示添加当前目录下的所有文件（除了 .gitignore 中指定的文件）。

  5. 提交代码到本地仓库:
    bash
    git commit -m "Initial commit of Spring Boot project with HelloController"
    git commit -m "Your commit message" 会将暂存区中的文件提交到本地 Git 仓库，并附带一条描述本次提交的说明信息。

步骤四：在 GitHub 上创建新仓库

接下来，您需要在 GitHub 上为您的项目创建一个远程仓库。

  1. 登录 GitHub: 访问 github.com 并登录您的账号。

  2. 创建新仓库:

    • 点击页面右上角的 + 号，选择 New repository。
    • Repository name: 输入 myfirstspringbootapp (通常与您的本地项目名称相同)。
    • Description: (可选) 填写项目的简要描述。
    • Public/Private: 选择 Public (公开) 或 Private (私有)。对于本教程，选择哪个都可以。
    • ⚠️ 重要: 不要 勾选 Add a README file, Add .gitignore, 或 Choose a license。因为我们已经在本地配置好了。
    • 点击 Create repository 按钮。

  3. 复制远程仓库 URL: 创建成功后，GitHub 会显示一个页面，其中包含您的仓库的 URL（例如 https://github.com/your-username/myfirstspringbootapp.git）。请复制这个 URL，我们稍后会用到。

步骤五：将本地项目推送到 GitHub

现在，我们将把本地 Git 仓库中的代码推送到刚刚创建的 GitHub 远程仓库。

  1. 添加远程仓库地址:
    回到您的项目根目录的终端中，执行以下命令。将 <YOUR_GITHUB_REPOSITORY_URL> 替换为您在步骤四中复制的 URL。

    bash
    git remote add origin <YOUR_GITHUB_REPOSITORY_URL>
    origin 是远程仓库的默认别名。

  2. 重命名主分支 (如果需要):
    在较新版本的 Git 中，默认分支名通常是 main。如果您的本地仓库默认分支是 master，建议将其重命名为 main 以与 GitHub 保持一致。

    bash
    git branch -M main

  3. 推送代码到 GitHub:
    bash
    git push -u origin main

    • git push: 将本地提交推送到远程仓库。
    • -u origin main: 设置 origin 远程仓库的 main 分支为上游（upstream）分支。这意味着以后您可以直接使用 git push 和 git pull，而无需指定 origin main。
    • 在执行此命令时，Git 可能会要求您输入 GitHub 用户名和密码，或者使用个人访问令牌（Personal Access Token）。

    推送成功后，刷新您的 GitHub 仓库页面，您应该能看到您的 Spring Boot 项目代码已经上传。

步骤六：进行更改并再次推送

让我们对代码进行一些修改，并体验一次完整的修改-提交-推送流程。

  1. 修改代码:
    在 HelloController.java 中添加一个新的接口。

    “`java
    package com.example.myfirstspringbootapp;

    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;

    @RestController
    public class HelloController {

    @GetMapping("/hello")
public String sayHello() {
    return "Hello, Spring Boot!";
}

@GetMapping("/greet")
public String greet() {
    return "Greetings from another endpoint!";
}

    }
    “`

  2. 添加更改到暂存区:
    bash
    git add .

  3. 提交更改到本地仓库:
    bash
    git commit -m "Add /greet endpoint"

  4. 推送更改到 GitHub:
    bash
    git push
    由于之前设置了上游分支 (-u 参数)，现在只需 git push 即可。

    刷新您的 GitHub 仓库页面，您会看到 HelloController.java 文件已更新，并且最新的提交记录也会显示。

总结

恭喜您！您已经成功地：
* 创建了一个 Spring Boot 项目。
* 编写了一个简单的 RESTful API。
* 在本地初始化了 Git 仓库并进行了首次提交。
* 在 GitHub 上创建了远程仓库。
* 将本地代码首次推送到 GitHub。
* 进行了代码修改，并再次提交和推送到 GitHub。

这只是您 Spring Boot 和 GitHub 旅程的开始。接下来，您可以探索更多功能，例如：
* 分支管理: 创建、切换、合并分支，实现并行开发。
* 拉取请求 (Pull Requests): 团队协作中代码审查的关键环节。
* Issues: 跟踪任务、Bug 和功能请求。
* Spring Boot 更多功能: 数据库集成、安全性、测试等。

不断实践，您将成为一名熟练的 Spring Boot 开发者和 Git 用户！

滚动至顶部