首页手记 Springboot项目开发入门教程

Springboot项目开发入门教程

标签：

SpringBoot

概述

本文将详细介绍Springboot项目开发入门，包括环境搭建、项目创建、控制器和数据访问等核心内容。通过约定优于配置的方式，Spring Boot简化了开发过程，使得开发者能够快速创建独立的、生产级别的Spring应用。文章还将介绍如何使用Spring Boot内置的监控功能来保证应用的健壮性。

Spring Boot简介

Spring Boot概述

Spring Boot是由Pivotal团队提供的基于Spring框架的一个开源项目，旨在简化Spring应用的初始搭建以及开发过程。它通过约定优于配置的方式，帮助开发者快速创建独立的、基于生产级别的Spring应用。Spring Boot可以自动配置Spring应用，使得开发者不需要手动配置各种复杂的依赖关系，从而大大提高了开发效率。

Spring Boot的核心目标是简化和加速Spring应用的开发过程，它通过以下几个方面来实现这一目标：

无需配置XML：Spring Boot鼓励开发者采用约定优于配置的方式，尽量减少XML配置，通过注解和属性文件来简化配置。
内嵌Web服务器：Spring Boot自带了嵌入式的Tomcat、Jetty或Undertow服务器，可以直接运行Java应用，无需在服务器上单独部署。
自动配置：Spring Boot能够根据项目的依赖关系，自动配置一些常见的框架，如数据库连接、缓存、邮件等。
生产就绪的特性：包含一个命令行接口、内嵌Web服务器、生产就绪的特性，如Actuator，可以监控应用的健康状况。

Spring Boot的优点

简化配置：Spring Boot通过约定优于配置的方式，大大简化了配置文件的编写工作，减少了大量的XML配置。
快速开发：Spring Boot提供了大量的自动配置，使得开发人员能够快速创建Spring应用，减少了手动配置的繁琐过程。
嵌入式服务器：Spring Boot默认包含一个嵌入式的Tomcat服务器，可以将应用打包成一个可执行的JAR文件，方便部署和运行。
生产级特性：Spring Boot内置了许多生产级的功能，如健康检查、监控、外部化配置等，使得应用更加健壮。
Standalone应用：Spring Boot应用可以打包成一个独立的JAR文件，可以直接运行，不需要部署在Tomcat、Jetty等应用服务器上，简化了部署过程。
快速启动：Spring Boot应用启动速度快，可以快速启动并运行应用，方便开发人员进行测试和调试。
依赖管理和自动配置：Spring Boot能够自动配置许多常见的库和框架，使得开发人员可以专注于业务逻辑的实现，而不是配置。

Spring Boot的环境搭建

安装Java

Spring Boot项目需要Java环境，建议使用Java 8及以上版本。首先确保系统中安装了Java，并设置好环境变量。可以通过命令java -version来检查Java是否安装以及版本是否符合要求。

安装Maven或Gradle

Spring Boot项目通常使用Maven或Gradle进行构建和管理依赖。这里以Maven为例：

下载并安装Maven。可以从Apache Maven官网上下载，然后解压到指定目录。
设置Maven环境变量。需要设置MAVEN_HOME环境变量，并将其路径添加到系统的PATH环境变量中。
验证Maven是否安装成功，可以通过命令mvn -v来检查。

参考代码：

$ mvn -v

创建Spring Boot项目

下载并安装Spring Tool Suite（STS），这是一个基于Eclipse的集成开发环境，集成了Spring Boot的快速启动功能。
打开STS，创建新的Spring Starter Project，选择合适的版本和依赖。

参考代码：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>

本地环境搭建

确保环境已经安装了Java、Maven和STS。
在IDE中创建一个新的Spring Boot项目。

生产环境搭建

安装Java和Maven。
配置服务器环境，确保服务器已经安装了Java和Maven。
部署JAR文件到服务器，启动应用。

参考代码：

$ cp target/demo-0.0.1-SNAPSHOT.jar /path/to/server/
$ cd /path/to/server/bin
$ java -jar demo-0.0.1-SNAPSHOT.jar

创建第一个Spring Boot项目

使用Spring Initializr创建项目

Spring Initializr是一个在线的项目生成工具，可以快速生成基于Spring Boot的项目。Spring Initializr地址：https://start.spring.io。

访问Spring Initializr网站，选择项目基本信息，如Java版本、项目名称、项目包名等。
选择项目依赖。常见的依赖有Web、JPA、Thymeleaf等。
点击“Generate”按钮，下载生成的项目压缩包。
解压压缩包，导入到IDE中进行开发。

参考代码：

<project>
    <groupId>com.example</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>
    <name>demo</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>
</project>

项目结构解析

Spring Boot项目的结构通常分为以下几个部分：

src/main/java：项目主要的Java代码目录，通常包含主启动类和相关的Controller、Service、Repository等。
src/main/resources：放置应用配置文件，如application.properties或application.yml。
src/test/java：测试代码目录，放置单元测试等。
src/main/resources/static：静态文件目录，如HTML、CSS、JavaScript等。
src/main/resources/templates：Thymeleaf模板文件目录，如果使用Thymeleaf模板引擎。
pom.xml：项目构建描述文件，定义了项目的依赖、构建信息等。

参考代码：

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

配置application.properties

application.properties是Spring Boot项目中配置文件的默认选择，也可以使用application.yml。配置文件中可以定义应用的各种属性，如端口、数据库连接等。

打开src/main/resources/application.properties文件。
添加一些基本配置，如端口号、数据库连接等。

参考代码：

server.port=8080
spring.datasource.url=jdbc:mysql://localhost:3306/demo
spring.datasource.username=root
spring.datasource.password=root

Spring Boot的核心注解和配置

@SpringBootApplication注解详解

@SpringBootApplication是Spring Boot的核心注解，主要功能是启用自动配置、组件扫描和Spring MVC功能。具体来说，它包含了以下几个注解的功能：

@Configuration：标记当前类是一个配置类，可以包含组件扫描和自动配置的一些逻辑。
@EnableAutoConfiguration：启用自动配置，根据类路径中其他添加的依赖来自动配置Spring应用。
@ComponentScan：组件扫描，扫描当前包及其子包中的所有标注了@Component、@Service、@Repository和@Controller的类。

使用@SpringBootApplication注解标注主启动类，可以非常方便地启动Spring Boot应用。

参考代码：

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

自动配置与@EnableAutoConfiguration

Spring Boot的自动配置功能可以根据开发者在项目中添加的依赖，自动配置一些常见的库和框架。以@EnableAutoConfiguration注解为例，它可以自动配置Spring应用，使得开发者无需手动配置各种依赖关系。

当项目中添加了spring-boot-starter-web依赖时，@EnableAutoConfiguration会自动配置Spring MVC、Tomcat等。
当项目中添加了spring-boot-starter-data-jpa依赖时，@EnableAutoConfiguration会自动配置数据库连接、JPA等。

Spring Boot的自动配置功能大大简化了开发过程，使得开发者可以更加专注于业务逻辑的实现，而不是配置。

参考代码：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>

配置文件的使用与作用

Spring Boot支持两种配置文件格式：application.properties和application.yml。配置文件用于定义应用的各种属性，如端口号、数据库连接等。

读取配置文件

Spring Boot使用@Value注解或@ConfigurationProperties注解来读取配置文件中的属性。@Value注解用于读取简单的属性，而@ConfigurationProperties注解用于将配置文件中的多个属性绑定到一个对象中。

参考代码：

package com.example.demo;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "app")
public class AppConfig {
    private String name;
    private int age;

    // 省略getter和setter方法
}

配置文件作用域

Spring Boot支持多环境配置，可以在配置文件中使用不同的前缀来区分不同的环境。例如，可以在application.properties中定义默认配置，然后在application-dev.properties和application-prod.properties中定义不同的环境配置。

参考代码：

# application.properties
spring.datasource.url=jdbc:mysql://localhost:3306/demo

# application-dev.properties
spring.datasource.username=root
spring.datasource.password=root

# application-prod.properties
spring.datasource.username=root
spring.datasource.password=root

控制器与RESTful API

创建控制器Controller

控制器是Spring Boot应用中处理HTTP请求的核心组件。每个控制器通常对应一组HTTP请求，处理请求并返回响应。

创建一个新的控制器类，使用@Controller或@RestController注解标注该类。
在控制器类中定义处理HTTP请求的方法，使用@RequestMapping注解指定请求的URL路径。

参考代码：

package com.example.demo;

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

@RestController
public class HelloController {
    @GetMapping("/hello")
    public String hello() {
        return "Hello, World!";
    }
}

返回JSON数据

Spring Boot支持返回JSON数据，可以使用@RestController注解来定义RESTful控制器，并使用@GetMapping注解返回JSON数据。

创建一个新的控制器类，使用@RestController注解标注该类。
在控制器类中定义返回JSON数据的方法，使用@GetMapping注解指定请求的URL路径，并返回一个对象。

参考代码：

package com.example.demo;

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

import java.util.HashMap;
import java.util.Map;

@RestController
public class UserController {
    @GetMapping("/user")
    public Map<String, String> getUser() {
        Map<String, String> user = new HashMap<>();
        user.put("name", "John");
        user.put("age", "30");
        return user;
    }
}

常用注解@RequestParam和@PathVariable的使用

Spring Boot提供了多种注解来处理请求参数，如@RequestParam注解用于获取URL中的查询参数，@PathVariable注解用于获取URL中的路径参数。

@RequestParam注解

@RequestParam注解用于获取URL中的查询参数。例如，URL中的?name=John，可以通过@RequestParam注解获取name参数。

参考代码：

package com.example.demo;

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

@RestController
public class HelloController {
    @GetMapping("/hello")
    public String hello(@RequestParam String name) {
        return "Hello, " + name + "!";
    }
}

@PathVariable注解

@PathVariable注解用于获取URL中的路径参数。例如，URL中的/user/123，可以通过@PathVariable注解获取123参数。

参考代码：

package com.example.demo;

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

@RestController
public class UserController {
    @GetMapping("/user/{id}")
    public String getUser(@PathVariable int id) {
        return "User ID: " + id;
    }
}

数据访问与持久化

使用Spring Data JPA进行数据库操作

Spring Data JPA是Spring Boot中用于数据访问的一个重要模块，提供了对JPA的简化操作，使得数据库操作更加方便。

添加spring-boot-starter-data-jpa依赖，以启用JPA支持。
创建持久化接口，继承JpaRepository接口。
使用持久化接口访问数据库。

参考代码：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
</dependencies>

创建持久化接口

持久化接口继承JpaRepository接口，并定义了基本的CRUD操作方法。

参考代码：

package com.example.demo.repository;

import org.springframework.data.jpa.repository.JpaRepository;

import com.example.demo.entity.User;

public interface UserRepository extends JpaRepository<User, Long> {
}

定义实体类

实体类需要标注@Entity注解，并定义持久化字段。

参考代码：

package com.example.demo.entity;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
    private int age;

    // 省略getter和setter方法
}

使用持久化接口

在控制器中使用持久化接口访问数据库。

参考代码：

package com.example.demo;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import com.example.demo.repository.UserRepository;
import com.example.demo.entity.User;

@RestController
public class UserController {
    @Autowired
    private UserRepository userRepository;

    @GetMapping("/user")
    public User getUser() {
        return userRepository.findById(1L).orElse(null);
    }
}

配置数据源和JPA

在application.properties文件中，配置数据源和JPA的相关属性。

参考代码：

spring.datasource.url=jdbc:mysql://localhost:3306/demo
spring.datasource.username=root
spring.datasource.password=root
spring.jpa.hibernate.ddl-auto=update

配置数据源属性

spring.datasource前缀下的属性用于配置数据源，如数据库URL、用户名、密码等。

配置JPA属性

spring.jpa前缀下的属性用于配置JPA，如生成DDL脚本、方言等。

常用的查询方法与分页

Spring Data JPA提供了多种查询方法，可以简化数据库操作。常用的方法有findAll、findById、save、deleteById等。

查询方法

使用持久化接口中的方法进行查询。

参考代码：

package com.example.demo.repository;

import org.springframework.data.jpa.repository.JpaRepository;

import com.example.demo.entity.User;

public interface UserRepository extends JpaRepository<User, Long> {
    User findByName(String name);
}

分页查询

使用Pageable接口进行分页查询。

参考代码：

package com.example.demo.repository;

import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.jpa.repository.JpaRepository;

import com.example.demo.entity.User;

public interface UserRepository extends JpaRepository<User, Long> {
    Page<User> findAll(Pageable pageable);
}

项目打包与部署

Maven的使用与项目打包

Spring Boot项目可以使用Maven或Gradle进行构建和打包。这里以Maven为例：

在pom.xml文件中配置打包插件，如spring-boot-maven-plugin。
使用Maven命令进行打包，生成可执行的JAR文件。

参考代码：

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

打包命令

使用mvn package命令进行打包。

参考代码：

$ mvn package

运行打包后的JAR文件

打包完成后，在target目录下生成了可执行的JAR文件，可以使用java -jar命令运行。

参考代码：

$ java -jar target/demo-0.0.1-SNAPSHOT.jar

部署Spring Boot应用到Tomcat或Spring Boot内置服务器

Spring Boot应用可以部署到Tomcat等应用服务器，也可以使用Spring Boot内置的Tomcat服务器运行。

部署到Tomcat

部署JAR文件到Tomcat服务器。
启动Tomcat服务器，访问应用。

参考代码：

$ cp target/demo-0.0.1-SNAPSHOT.jar /path/to/tomcat/webapps/
$ cd /path/to/tomcat/bin
$ ./startup.sh

使用Spring Boot内置服务器

直接运行打包后的JAR文件，使用Spring Boot内置的Tomcat服务器运行。

参考代码：

$ java -jar target/demo-0.0.1-SNAPSHOT.jar

项目监控与健康检查

Spring Boot提供了Spring Boot Actuator模块，用于监控应用的健康状况。

启用监控功能

添加spring-boot-starter-actuator依赖。
配置application.properties文件，启用监控功能。

参考代码：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
</dependencies>

配置监控功能

在application.properties文件中，配置监控功能。

参考代码：

management.endpoints.web.exposure.include=*
management.endpoint.health.show-details=always

访问监控端点

启动应用后，可以通过访问/actuator端点查看应用的健康状况。

参考代码：

$ curl http://localhost:8080/actuator

总结

通过本教程，我们学习了Spring Boot的基本概念、环境搭建、项目创建、控制器、数据访问与持久化、项目打包与部署以及项目监控与健康检查等。Spring Boot通过约定优于配置的方式，大大简化了开发过程，使得开发者可以更加专注于业务逻辑的实现，而不是配置。希望本教程能够帮助读者快速入门Spring Boot，提高开发效率。

点击查看更多内容

为 TA 点赞

若觉得本文不错，就分享一下吧！

评论

评论

共同学习，写下你的评论

评论加载中...

展开查看更多评论

作者其他优质文章

正在加载中

幕布斯6054654

手记
篇

粉丝

219

获赞与收藏

1011

关注作者，订阅最新文章

阅读免费教程

后端通用面试教程

41个小节 30583 343

网络编程入门教程

20个小节 12561 237

Pandas 入门教程

25个小节 18499 337

推荐

评论

收藏

共同学习，写下你的评论



感谢您的支持，我会继续努力的～

扫码打赏，你说多少就多少

赞赏金额会直接到老师账户

支付方式

打开微信扫一扫，即可进行扫码打赏哦

今天注册有机会得

100积分直接送

付费专栏免费学

大额优惠券免费领

立即参与放弃机会

点击
抽奖

慕课手记新用户专享福利

恭喜你，你的运气太好了，居然抽中了 100个积分！

恭喜你，抽中了价值元的专栏！

太棒了，直接落到你账户里！

积分商城里的罗技鼠标、机械键盘、
Kindle 阅读器、小米平衡车
Apple iPad （10.2英寸）、大额优惠券
在等着你去兑换了噢

作者：

免费赠送

兑换码：1111222211 复制

优惠券可用于购买实战课、体系课
无门槛使用

先去看看，有什么好东西马上兑换我爱学习，选课去


热搜

最近搜索清空

Springboot项目开发入门教程

安装Java

安装Maven或Gradle

创建Spring Boot项目

本地环境搭建

生产环境搭建

读取配置文件

配置文件作用域

@RequestParam注解

@PathVariable注解

创建持久化接口

定义实体类

使用持久化接口

配置数据源属性

配置JPA属性

查询方法

分页查询

打包命令

运行打包后的JAR文件

部署到Tomcat

使用Spring Boot内置服务器

启用监控功能

配置监控功能

访问监控端点

阅读免费教程