Spring Boot 文档示例

Spring Boot 文档示例

概述

本文档介绍了如何使用 Spring Boot 创建一个简单的 RESTful API，该 API 提供了获取用户信息的功能。

环境准备

• Java 11 或更高版本
• Spring Boot 3.0.x 或更高版本
• Maven 或 Gradle 构建工具

创建项目

使用 Spring Initializr 创建一个新的 Spring Boot 项目：

https://start.spring.io/

选择以下依赖项：

• Spring Web
• Spring Data JPA
• H2 Database

项目结构

``` └── src └── main └── java └── com └── example └── springboot └── demo ├── controller │ └── UserController.java ├── entity │ └── User.java ├── repository │ └── UserRepository.java ├── service │ └── UserService.java └── DemoApplication.java

```

代码示例

1. User实体

```java package com.example.springboot.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;

// 省略getter和setter方法

} ```

2. UserRepository接口

```java package com.example.springboot.demo.repository;

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

public interface UserRepository extends JpaRepository {

} ```

3. UserService接口

```java package com.example.springboot.demo.service;

import com.example.springboot.demo.entity.User;

public interface UserService {

User createUser(User user);

User getUserById(Long id);

} ```

4. UserServiceImpl类

```java package com.example.springboot.demo.service;

import com.example.springboot.demo.entity.User; import com.example.springboot.demo.repository.UserRepository; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service;

@Service public class UserServiceImpl implements UserService {

@Autowired
private UserRepository userRepository;

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

@Override
public User getUserById(Long id) {
    return userRepository.findById(id).orElse(null);
}

} ```

5. UserController类

```java package com.example.springboot.demo.controller;

import com.example.springboot.demo.entity.User; import com.example.springboot.demo.service.UserService; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.*;

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

@Autowired
private UserService userService;

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

@GetMapping("/{id}")
public User getUserById(@PathVariable Long id) {
    return userService.getUserById(id);
}

} ```

6. DemoApplication类

```java package com.example.springboot.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);
}

} ```

运行项目

使用 Maven 或 Gradle 构建并运行项目。

测试 API

访问以下 URL 测试 API：

• 创建用户： POST /users
• 获取用户： GET /users/{id}

总结

本文档展示了如何使用 Spring Boot 创建一个简单的 RESTful API。你可以根据需要扩展该 API，添加更多功能和数据模型。