首页手记 Spring Boot企业级开发入门教程

Spring Boot企业级开发入门教程

标签：

Java SpringBoot 微服务

概述

Spring Boot企业级开发提供了快速搭建和开发环境的能力，通过自动配置和内嵌容器简化了开发流程。本文将详细介绍如何搭建开发环境、创建项目及配置依赖，并通过示例展示如何构建第一个企业级应用。此外，还将讲解数据库操作、RESTful服务开发、异常处理及安全性配置。

Spring Boot简介及环境搭建

Spring Boot介绍

Spring Boot是由Pivotal团队提供的框架，主要目的是简化使用Spring进行开发的难度，提供了大量的自动配置功能，从而避免了繁重的XML配置以及繁琐的代码编写过程。Spring Boot旨在简化新Spring应用的初始搭建以及开发过程，它通过一系列约定优于配置（Convention over Configuration）的方式，使得开发人员可以快速地将精力投入到业务逻辑的实现上，而不是花大量时间在环境配置和依赖管理上。

Spring Boot的核心特性包括：

自动配置：根据应用类型自动配置Spring。
内嵌Web容器：支持内嵌Tomcat、Jetty和Undertow。
整合第三方库：如MyBatis、Redis、RabbitMQ等。
starter依赖管理：通过简单的依赖引入，快速完成项目搭建。
Actuator监控：提供生产环境监控能力。
全新的命令行接口（CLI）：可以快速原型开发。

开发环境搭建

安装Java环境

下载并安装最新版本的JDK，建议使用Java 8或更高版本。

设置环境变量：确保JAVA_HOME、PATH和CLASSPATH环境变量已正确设置。

export JAVA_HOME=/usr/lib/jvm/java-11-openjdk
export PATH=$JAVA_HOME/bin:$PATH
export CLASSPATH=.:$JAVA_HOME/lib/dt.jar:$JAVA_HOME/lib/tools.jar

安装Maven

设置环境变量：

export MAVEN_HOME=/path/to/maven
export PATH=$MAVEN_HOME/bin:$PATH

安装IDE

推荐使用IntelliJ IDEA或Eclipse作为开发环境，这里以IntelliJ IDEA为例：

下载并安装IntelliJ IDEA。
配置IDEA：
- 打开IntelliJ IDEA，选择File -> Settings -> Build, Execution, Deployment -> Build Tools -> Maven。
- 设置Maven的安装路径。
- 确保Maven的User settings file和Local repository正确设置。

工具选择与配置

创建Spring Boot项目

使用Spring Initializr或Spring Boot CLI来创建新的Spring Boot项目。

使用Spring Initializr创建项目：

访问https://start.spring.io/，选择所需的技术栈，如Spring Web、JPA等，点击Generate按钮下载压缩包。
使用Spring Boot CLI创建项目：

创建一个新目录，并在该目录下执行以下命令：
```
spring init --dependencies=web,jpa,thymeleaf demo-app
cd demo-app
```
使用IDEA创建项目：

在IntelliJ IDEA中，选择File -> New -> Project，选择Spring Initializr，填写相关信息并创建项目。

添加依赖

在Spring Boot项目中，依赖管理非常简单，只需要在pom.xml文件中添加所需的依赖。例如，添加Spring Web和JPA依赖：

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

配置文件设置

Spring Boot支持多种配置文件格式，如.properties和.yml。下面是一个典型的application.yml文件示例：

spring:
  application:
   name: demo-app
   server:
      port: 8080
      contextPath: /api
   datasource:
      url: jdbc:mysql://localhost:3306/demo
      username: root
      password: password
   jpa:
      hibernate:
         ddl-auto: update
      show-sql: true

快速构建第一个企业级应用

创建Spring Boot项目

在上面的开发环境搭建中，我们已经创建了一个基础的Spring Boot项目。接下来，我们将进一步完善这个项目以实现一个简单的RESTful API。

添加依赖

继续在pom.xml文件中添加所需的依赖。例如，添加Spring Web、JPA和Thymeleaf的依赖：

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

配置文件设置

在application.yml文件中添加数据库连接配置：

spring:
  application:
   name: demo-app
   server:
      port: 8080
      contextPath: /api
   datasource:
      url: jdbc:mysql://localhost:3306/demo
      username: root
      password: password
   jpa:
      hibernate:
         ddl-auto: update
      show-sql: true

运行第一个企业级应用

创建一个简单的RESTful API，用于展示“Hello World”。

创建一个HelloController类，位于src/main/java/com/example/demo/controller目录下：

package com.example.demo.controller;

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!";
   }
}

运行Spring Boot应用，在IDEA中右键点击DemoApplication.java，选择Run。
打开浏览器，访问http://localhost:8080/api/hello，显示“Hello World!”即表示成功。

数据访问

使用JPA进行数据库操作

Spring Data JPA是一个简化了数据库操作的库，它基于JPA规范，提供了多种抽象层，使得开发人员可以专注于业务逻辑，而不必担心底层数据库的实现细节。

配置数据库连接

在application.yml文件中配置数据库连接信息：

spring:
  application:
   name: demo-app
   server:
      port: 8080
      contextPath: /api
   datasource:
      url: jdbc:mysql://localhost:3306/demo
      username: root
      password: password
   jpa:
      hibernate:
         ddl-auto: update
      show-sql: true

实体类定义与数据操作方法编写

创建一个简单的实体类User，位于src/main/java/com/example/demo/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 String email;

    // Getters and Setters
}

创建一个UserRepository接口，继承自JpaRepository，用于定义基本的CRUD操作：

package com.example.demo.repository;

import com.example.demo.entity.User;
import org.springframework.data.jpa.repository.JpaRepository;

import java.util.List;

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

数据库迁移与版本管理

使用Spring Boot的spring-boot-maven-plugin插件自动运行数据库迁移脚本。可以在pom.xml文件中添加以下配置：

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

创建一个schema.sql文件来初始化数据库：

-- src/main/resources/schema.sql
CREATE TABLE users (
    id BIGINT AUTO_INCREMENT PRIMARY KEY,
    name VARCHAR(255) NOT NULL,
    email VARCHAR(255) NOT NULL
);

创建一个data.sql文件来填充初始数据：

-- src/main/resources/data.sql
INSERT INTO users (name, email) VALUES ('Alice', 'alice@example.com');
INSERT INTO users (name, email) VALUES ('Bob', 'bob@example.com');

RESTful服务开发

创建RESTful API

在Spring Boot中创建RESTful API非常简单，只需定义一个控制器类，使用Spring MVC注解来定义HTTP处理方法。

控制器设计

创建一个UserController类，位于src/main/java/com/example/demo/controller目录下：

package com.example.demo.controller;

import com.example.demo.entity.User;
import com.example.demo.repository.UserRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("/api/users")
public class UserController {

    @Autowired
    private UserRepository userRepository;

    @GetMapping
    public List<User> getAllUsers() {
        return userRepository.findAll();
    }

    @GetMapping("/{id}")
    public ResponseEntity<User> getUserById(@PathVariable Long id) {
        User user = userRepository.findById(id).orElse(null);
        if (user == null) {
            return ResponseEntity.notFound().build();
        }
        return ResponseEntity.ok(user);
    }

    @PostMapping
    public User createUser(@RequestBody User user) {
        return userRepository.save(user);
    }

    @PutMapping("/{id}")
    public ResponseEntity<User> updateUser(@PathVariable Long id, @RequestBody User user) {
        if (!userRepository.existsById(id)) {
            return ResponseEntity.notFound().build();
        }
        user.setId(id);
        return ResponseEntity.ok(userRepository.save(user));
    }

    @DeleteMapping("/{id}")
    public ResponseEntity<Void> deleteUser(@PathVariable Long id) {
        if (!userRepository.existsById(id)) {
            return ResponseEntity.notFound().build();
        }
        userRepository.deleteById(id);
        return ResponseEntity.noContent().build();
    }
}

响应模型设计

在上面的控制器中，我们使用了Spring MVC提供的ResponseEntity来返回HTTP响应。例如，ResponseEntity.ok(user)表示成功返回一个用户对象。

测试API

可以使用Postman或curl工具测试RESTful API。例如，使用curl命令创建一个新用户：

curl -X POST -H "Content-Type: application/json" -d '{"name":"Charlie", "email":"charlie@example.com"}' http://localhost:8080/api/users

异常处理与日志记录

异常处理机制

Spring Boot提供了一个全局异常处理机制，可以集中处理所有的异常。

自定义异常类

定义一个自定义异常类UserNotFoundException：

package com.example.demo.exceptions;

import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ResponseStatus;

@ResponseStatus(HttpStatus.NOT_FOUND)
public class UserNotFoundException extends RuntimeException {
    public UserNotFoundException(String message) {
        super(message);
    }
}

在控制器中抛出此异常：

package com.example.demo.controller;

import com.example.demo.entity.User;
import com.example.demo.repository.UserRepository;
import com.example.demo.exceptions.UserNotFoundException;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("/api/users")
public class UserController {

    @Autowired
    private UserRepository userRepository;

    @GetMapping("/{id}")
    public ResponseEntity<User> getUserById(@PathVariable Long id) {
        User user = userRepository.findById(id).orElse(null);
        if (user == null) {
            throw new UserNotFoundException("User not found with id: " + id);
        }
        return ResponseEntity.ok(user);
    }
}

日志框架配置

Spring Boot默认使用SLF4J作为日志门面，可以配置日志框架，如Logback、Log4j等。以下是一个Logback配置示例：

在src/main/resources目录下创建logback-spring.xml文件：

<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="debug">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

日志输出格式化

通过修改logback-spring.xml文件中的配置，可以自定义日志输出格式。例如，可以添加更多的日志信息，如线程名、毫秒时间戳等：

<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{35} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="debug">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

安全性与认证

介绍Spring Security

Spring Security是一个强大的安全框架，为Java应用程序提供了认证和授权功能。它可以与Spring Boot无缝集成，简化安全配置过程。

用户认证与授权配置

在Spring Boot中配置Spring Security，需要创建一个安全配置类SecurityConfig：

package com.example.demo.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
import org.springframework.security.crypto.password.PasswordEncoder;

@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
            .authorizeRequests()
                .antMatchers("/", "/home").permitAll()
                .anyRequest().authenticated()
            .and()
                .formLogin()
                .loginPage("/login")
                .permitAll()
            .and()
                .logout()
                .permitAll();
    }

    @Bean
    public PasswordEncoder passwordEncoder() {
        return new BCryptPasswordEncoder();
    }
}

实现`UserDetailsService`接口

为Spring Security提供用户认证服务，需要实现UserDetailsService接口：

package com.example.demo.service;

import com.example.demo.entity.User;
import com.example.demo.repository.UserRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.core.userdetails.UsernameNotFoundException;
import org.springframework.stereotype.Service;

@Service
public class UserDetailsServiceImpl implements UserDetailsService {

    @Autowired
    private UserRepository userRepository;

    @Override
    public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
        User user = userRepository.findByUsername(username)
                .orElseThrow(() -> new UsernameNotFoundException("User not found with username: " + username));
        return org.springframework.security.core.userdetails.User
                .withUsername(user.getUsername())
                .password(user.getPassword())
                .authorities(user.getAuthorities())
                .build();
    }
}

配置`application.yml`文件

在application.yml文件中添加Spring Security的相关配置：

spring:
  application:
   name: demo-app
   server:
      port: 8080
      contextPath: /api
   datasource:
      url: jdbc:mysql://localhost:3306/demo
      username: root
      password: password
   jpa:
      hibernate:
         ddl-auto: update
      show-sql: true
 security:
    basic:
       enabled: true
    oauth2:
       client:
          registration:
             github:
                clientId: YOUR_GITHUB_CLIENT_ID
                clientSecret: YOUR_GITHUB_CLIENT_SECRET
          provider:
             github:
                issuerUri: https://github.com
                authorizationUri: https://github.com/login/oauth/authorize
                tokenUri: https://github.com/login/oauth/access_token
                userInfoUri: https://api.github.com/user

配置登录页面和控制器

在控制器中添加登录页面和登录处理逻辑：

package com.example.demo.controller;

import org.springframework.security.core.annotation.AuthenticationPrincipal;
import org.springframework.security.core.userdetails.User;
import org.springframework.security.web.authentication.LoginUrlAuthenticationEntryPoint;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class LoginController {

    @GetMapping("/login")
    public String login() {
        return "login";
    }

    @GetMapping("/user")
    public String user(@AuthenticationPrincipal User user, Model model) {
        model.addAttribute("user", user);
        return "user";
    }
}

在src/main/resources/templates目录下创建一个登录页面login.html：

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <title>Login</title>
</head>
<body>
    <h1>Login</h1>
    <form action="/login" method="post">
        <label for="username">Username:</label>
        <input type="text" id="username" name="username" required />
        <br />
        <label for="password">Password:</label>
        <input type="password" id="password" name="password" required />
        <br />
        <button type="submit">Login</button>
    </form>
</body>
</html>

常见问题与解决方案

错误提示：No qualifying bean of type 'org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter' available
- 确保SecurityConfig类继承自WebSecurityConfigurerAdapter，并且已启用@EnableWebSecurity注解。
登录页面显示不正确
- 确保配置文件中启用了formLogin功能，并正确配置了登录页面路径。
无法访问受保护的资源
- 确保在SecurityConfig中正确配置了权限管理规则。

通过以上步骤，您可以构建一个基本的安全认证功能，确保了应用程序的安全性。

点击查看更多内容

为 TA 点赞

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

评论

评论

共同学习，写下你的评论

评论加载中...

展开查看更多评论

作者其他优质文章

正在加载中

料青山看我应如是

手记
篇

粉丝

97

获赞与收藏

354

关注作者，订阅最新文章

阅读免费教程

Java并发工具

23个小节 19187 313

Java 并发原理入门教程

26个小节 38860 566

Java 入门教程

50个小节 340923 3155

推荐

评论

收藏

共同学习，写下你的评论



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

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

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

支付方式

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

今天注册有机会得

100积分直接送

付费专栏免费学

大额优惠券免费领

立即参与放弃机会

点击
抽奖

慕课手记新用户专享福利

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

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

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

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

作者：

免费赠送

兑换码：1111222211 复制

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

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

热搜

最近搜索清空

Spring Boot企业级开发入门教程

Spring Boot介绍

开发环境搭建

安装Java环境

安装Maven

安装IDE

工具选择与配置

创建Spring Boot项目

添加依赖

配置文件设置

创建Spring Boot项目

添加依赖

配置文件设置

运行第一个企业级应用

使用JPA进行数据库操作

配置数据库连接

实体类定义与数据操作方法编写

数据库迁移与版本管理

创建RESTful API

控制器设计

响应模型设计

测试API

异常处理机制

自定义异常类

日志框架配置

日志输出格式化

介绍Spring Security

用户认证与授权配置

实现UserDetailsService接口

配置application.yml文件

配置登录页面和控制器

常见问题与解决方案

阅读免费教程

实现`UserDetailsService`接口

配置`application.yml`文件