Skip to content

README.md

Latest commit

 

History

History
207 lines (172 loc) · 8.55 KB

README.md

File metadata and controls

207 lines (172 loc) · 8.55 KB

Spring Boot Backend Project

Simplified Chinese | English

Project Overview

This project is an enterprise-level permission management system built with Spring Boot 4.0.2. It uses JWT authentication and the RBAC (Role-Based Access Control) model, providing complete user, role, permission, and group management functionality.

Swagger API documentation: https://yluiop123.github.io/orange/#/swagger

Tech Stack

  • Backend Framework: Spring Boot 4
  • Java Version: Java 17+
  • Database: PostgreSQL
  • Security Framework: Spring Security + JWT
  • API Documentation: SpringDoc OpenAPI 3.0
  • Cache: Caffeine
  • ORM: Spring Data JPA
  • Build Tool: Maven
  • Development Tool: Lombok

Quick Start

Clone the Project

git clone <repository-url>
cd springboot

Database Configuration

Create the database and execute ddl.sql and ddm.sql under the database folder

Modify database connection info in application.yaml

-- Modify database connection info in application.yaml
spring:
  datasource:
    url: jdbc:postgresql://localhost:5432/orange
    username: your_username
    password: your_password

访问地址

Production Environment Configuration

Generate JWT Keys for Production Environment

# Generate RSA private key
openssl genpkey -algorithm RSA -out private_key.pem -pkeyopt rsa_keygen_bits:2048

# Generate public key
openssl rsa -pubout -in private_key.pem -out public_key.pem

Place the generated private_key.pem and public_key.pem in a custom directory on the server.

Modify application.yaml:

jwt:
  private-key: classpath:keys/private_key.pem
  public-key: classpath:keys/public_key.pem

Configure Database Password

In production, configure the database password using the environment variable DB_PASSWORD. The default value for local development is postgres.

    # Database password, retrieved from environment variable, default for local development is postgres
    password: ${DB_PASSWORD:postgres}

Project Structure

springboot/
├── src/main/java/com/orange/
│   ├── config/                    # Configuration classes
│   ├── controller/               # Controller layer
│   │   ├── login/               # Login-related controllers
│   │   └── system/              # System management controllers
│   ├── domain/                   # Domain model layer
│   │   ├── common/              # Common models
│   │   ├── login/               # Login models
│   │   └── system/              # System models
│   ├── entity/                   # Entity classes
│   ├── repository/              # Data access layer
│   ├── security/                # Security configuration
│   ├── service/                 # Business logic layer
│   └── OrangeBootApplication.java # Main application
├── src/main/resources/
│   ├── keys/                    # JWT keys (for testing; use custom keys in production)
│   └── application.yaml         # Configuration file
└── pom.xml                      # Maven dependencies

Database Design

Relationships

The core entities include: User, Role, Permission, and Group.

Many-to-one: User → Group (a user belongs to one group) Many-to-many: User ↔ Role (via sys_user_role) Many-to-many: Role ↔ Permission (via sys_role_permission) Many-to-many: User ↔ Permission (via sys_user_permission, used to grant extra permissions beyond roles)

Core Tables

Group Table (sys_group)

Field Type Required Default Description
id varchar Yes - Group ID (primary key)
name varchar No - Group name
order_num int4 No - Order number
status varchar No - Status
parent_id varchar No - Parent group ID
create_time timestamp No now() Creation time
update_time timestamp No now() Update time

User Table (sys_user)

Field Type Required Default Description
id varchar(255) Yes - User ID (primary key)
username varchar(255) Yes - Username (unique)
password varchar No - Encrypted password
name varchar(255) No - Name
email varchar(255) No - Email
phone varchar(255) No - Phone
group_id varchar No - Group ID
status varchar(255) No - Status
create_time timestamp No now() Creation time
update_time timestamp No now() Update time

Role Table (sys_role)

Field Type Required Default Description
id varchar Yes - Role ID (primary key)
name varchar No - Role name
status varchar No - Status
create_time timestamp No now() Creation time
update_time timestamp No now() Update time

Permission Table (sys_permission)

Field Type Required Default Description
id varchar Yes - Permission ID
name varchar No - Permission name
path varchar No - Path (route/URL)
action varchar No - Action (GET/POST etc.)
type varchar No - Type (MENU/BUTTON)
status varchar No - Status
parent_id varchar No - Parent permission ID
order_num int4 No - Order number
create_time timestamp No now() Creation time
update_time timestamp No now() Update time

Relation Tables

User-Role (sys_user_role)

Used to record roles assigned to users.

  • user_id: User ID
  • role_id: Role ID

Role-Permission (sys_role_permission)

Used to record permissions granted to roles.

  • role_id: Role ID
  • permission_id: Permission ID

User-Permission (sys_user_permission)

Used to record permissions granted to users.

  • user_id: User ID
  • permission_id: Permission ID

Permission Control

  • RBAC Model: This system uses the RBAC model to manage users, roles, permissions, and groups via association tables.
  • API Permission Control: Uses Spring Security with@PreAuthorize。 Permission rule format:type#path:action（action can also betype#path）or permission code 。 type permission type(menu/directory/action/function/api)， path permission path(route/URL)， action custom permission action(add/delete/edit etc.)。 Permission logic implemented in com.orange.security.JwtUserDetailsService.java in the getPermissionStrs method.
    @Operation(summary = "Query User List", description = "Query users list based on query conditions")
    @PostMapping
    @PreAuthorize("hasAuthority('menu#/system/user')") //type#path:action configuration
//@PreAuthorize("hasAuthority('000500')")  //permission code configuration
    public Response<PageData<UserBean>> queryUsers(@RequestBody QueryUserReq req) {
        PageData<UserBean> pageData = userService.queryUsers(req);
        return Response.ok(pageData);
    }

    @Operation(summary = "Delete Users", description = "Delete users based on user ID list")
    @DeleteMapping
    @PreAuthorize("hasAuthority('menu#/system/user:delete')")
    public Response<String> deleteUsers(@RequestBody DeleteUserReq req) {
        userService.deleteUsers(req.getIds());
        return Response.ok("Delete success");
    }