Prise en main rapide - nbacheng/nbcio-boot

Fichiers source

Cette page est générée à partir des fichiers source suivants :

Nbcio-Boot est une plateforme de gestion d'entreprise NBCIO (亿事达) basée sur le framework Jeecg-Boot 3.0. Ce guide présente les étapes nécessaires pour configurer, lancer et vérifier le fonctionnement de l'application en environnement de développement ou via Docker.

Présentation du projet et accès à la démonstration

Nbcio-Boot V1.0.0 est une plateforme de gestion d'entreprise qui s'appuie sur Jeecg-Boot 3.0 (publié le 1er novembre 2021). Le projet propose des fonctionnalités avancées incluant un workflow basé sur Flowable 6.7.2, des processus d'approbation de salaires intégrés avec DingTalk, et une fonctionnalité de chat (README.md:1-13).

Une démonstration en ligne est disponible pour tester la plateforme avant installation. L'adresse d'accès est http://218.75.87.38:9888. Les comptes de démonstration disponibles sont admin, zhangsan, et 01015521328526, tous avec le mot de passe 123456 (README.md:54-57).

Accès aux ressources :

Dépôt backend (Gitee) : https://gitee.com/nbacheng/nbcio-boot
Dépôt frontend (Gitee) : https://gitee.com/nbacheng/nbcio-vue
Documentation officielle : http://doc.jeecg.com
FAQ : http://jeecg.com/doc/qa

Prérequis et environnement technique

Stack technologique backend

Le projet repose sur une architecture technique moderne et éprouvée (README.md:24-38) :

Composant	Technologie	Version
Framework de base	Spring Boot	2.3.5.RELEASE
Persistance	Mybatis-plus	3.4.3.1
Sécurité	Apache Shiro + JWT	1.7.0 / 3.11.0
Pool de connexions	Alibaba Druid	1.1.22
Cache	Redis	-
Logging	Logback	-
Utilitaires	Fastjson, POI, Swagger-ui, Quartz, Lombok	-

Environnement de développement requis

La configuration minimale pour le développement est définie comme suit (README.md:41-52) :

Élément	Exigence
Langage	Java 8
IDE	STS avec plugin Lombok ou IDEA
Gestion des dépendances	Maven
Base de données	MySQL 5.7+, Oracle 11g, SqlServer, PostgreSQL ou bases de données nationales
Cache	Redis

Note importante : L'installation du plugin Lombok dans l'IDE est obligatoire pour une compilation correcte du projet.

Configuration et lancement rapide avec Docker

Architecture des conteneurs

Docker Compose orchestre trois services principaux pour un déploiement rapide (docker-compose.yml:1-42) :

正在加载图表渲染器...

Configuration des services Docker

Le fichier docker-compose.yml définit les services suivants :

Service MySQL (docker-compose.yml:3-21) :

Image construite depuis ./db
Port exposé : 3306:3306
Mot de passe root : root
Configuration : UTF8MB4, timezone Asia/Shanghai, lower_case_table_names=1

Service Redis (docker-compose.yml:23-29) :

Image : redis:5.0
Port exposé : 6379:6379
Hostname : nbcio-boot-redis

Service Application (docker-compose.yml:31-42) :

Image construite depuis ./nbcio-boot-module-system
Port exposé : 8080:8080
Dépendances : MySQL et Redis

Avertissement sur les conflits de ports

Avant de démarrer les conteneurs Docker, il est impératif d'arrêter les services MySQL et Redis locaux s'ils sont installés, afin d'éviter les conflits de ports (README.md:66-68) :

bash
1# Sur Windows
2net stop redis
3net stop mysql
4
5# Sur Linux/macOS
6sudo systemctl stop redis
7sudo systemctl stop mysql

Configuration manuelle de lapplication

Configuration des hôtes et profil Spring

Pour un déploiement manuel (sans Docker), la configuration des hôtes est requise dans le fichier /etc/hosts (Linux/macOS) ou C:\Windows\System32\drivers\etc\hosts (Windows) (README.md:70-76) :

bash
1# Ajouter les lignes suivantes au fichier hosts
2127.0.0.1   nbcio-boot-redis
3127.0.0.1   nbcio-boot-mysql
4127.0.0.1   nbcio-boot-system

Le profil actif se configure dans application.yml (README.md:77-78) :

yaml
1spring:
2  profiles:
3    active: dev

Le fichier de configuration principal confirme l'utilisation de la variable d'environnement env avec dev comme valeur par défaut (nbcio-boot-module-system/src/main/resources/application.yml:1-6).

Paramétrage de la base de données et Redis

Le fichier application-dev.yml contient les paramètres de connexion à modifier selon l'environnement (README.md:80-81) :

Configuration MySQL (nbcio-boot-module-system/src/main/resources/application-dev.yml:137-142) :

yaml
1datasource:
2  dynamic:
3    datasource:
4      master:
5        url: jdbc:mysql://192.168.199.151:3306/nbcio-boot?characterEncoding=UTF-8&useUnicode=true&useSSL=false&tinyInt1isBit=false&allowPublicKeyRetrieval=true&serverTimezone=Asia/Shanghai
6        username: root
7        password: mastermysql
8        driver-class-name: com.mysql.cj.jdbc.Driver

Configuration Redis (nbcio-boot-module-system/src/main/resources/application-dev.yml:150-161) :

yaml
1redis:
2  database: 0
3  host: 192.168.199.151
4  lettuce:
5    pool:
6      max-active: 8
7      max-idle: 8
8      max-wait: -1ms
9      min-idle: 0
10    shutdown-timeout: 100ms
11  password: 'masterredis'
12  port: 6379

Paramètres à adapter :

Remplacer 192.168.199.151 par l'adresse de votre serveur MySQL/Redis
Modifier les mots de passe (mastermysql, masterredis) selon votre configuration
Le nom de la base de données par défaut est nbcio-boot

Configuration du serveur et contexte

L'application écoute sur le port 8080 avec un contexte de servlet /nbcio-boot (nbcio-boot-module-system/src/main/resources/application-dev.yml:1-10) :

yaml
1server:
2  port: 8080
3  servlet:
4    context-path: /nbcio-boot

Compilation et vérification du démarrage

Processus de build avec Maven

La compilation du projet s'effectue via Maven à la racine du projet (README.md:83-84) :

bash
1# Se placer à la racine du projet jeecg-boot
2cd nbcio-boot
3
4# Compiler le projet
5mvn clean package

Cette commande génère les fichiers JAR nécessaires au déploiement dans les répertoires target/ de chaque module.

Accès à l'interface Swagger et documentation

Une fois l'application démarrée, l'interface Swagger UI est accessible pour tester les API (README.md:86-87) :

http://localhost:8080/nbcio-boot/doc.html

Note : L'activation de Swagger est requise pour accéder à cette interface. Vérifier la configuration Swagger dans les propriétés de l'application si l'interface n'est pas accessible.

La documentation technique officielle et la FAQ sont disponibles aux adresses suivantes (README.md:58-62) :

Documentation en ligne : http://doc.jeecg.com
Questions fréquentes : http://jeecg.com/doc/qa

Chemin dexécution recommandé

Méthode 1 : Docker Compose (recommandée pour démarrage rapide)

Cette méthode permet de lancer l'ensemble de l'infrastructure en une seule commande.

bash
1# 1. Arrêter les services locaux (si présents)
2net stop redis    # Windows
3net stop mysql    # Windows
4
5# 2. Cloner le dépôt
6git clone https://gitee.com/nbacheng/nbcio-boot.git
7cd nbcio-boot
8
9# 3. Lancer les conteneurs
10docker-compose up -d
11
12# 4. Vérifier l'accès
13# MySQL: localhost:3306 (user: root, password: root)
14# Redis: localhost:6379
15# Application: http://localhost:8080/nbcio-boot/doc.html

Méthode 2 : Déploiement manuel (pour développement)

Étape	Commande/Action	Référence
1	Configurer le fichier hosts	README.md:70-76
2	Modifier `application-dev.yml` (DB/Redis)	README.md:80-81
3	Compiler : `mvn clean package`	README.md:83-84
4	Démarrer l'application Java	-
5	Accéder à Swagger UI	README.md:86-87

Problèmes courants et dépannage

Problème 1 : Conflit de ports au démarrage Docker

Symptôme : Erreur "port is already allocated" lors de docker-compose up.

Cause : Des services MySQL ou Redis locaux utilisent déjà les ports 3306 ou 6379.

Solution : Arrêter les services locaux avant de lancer Docker (README.md:66-68) :

bash
1# Identifier les processus utilisant les ports
2netstat -ano | findstr :3306
3netstat -ano | findstr :6379
4
5# Arrêter les services
6net stop mysql
7net stop redis

Problème 2 : Erreur de connexion à la base de données

Symptôme : L'application ne démarre pas avec une erreur de connexion MySQL refusée.

Cause : Configuration incorrecte dans application-dev.yml ou base de données non créée.

Solution :

Vérifier les paramètres de connexion (nbcio-boot-module-system/src/main/resources/application-dev.yml:137-142)
S'assurer que la base nbcio-boot existe
Vérifier que l'adresse IP et le port sont corrects
Confirmer les identifiants (root / mastermysql par défaut)

Problème 3 : Erreur de connexion Redis

Symptôme : Timeout ou connexion refusée vers Redis.

Cause : Redis non démarré ou configuration incorrecte.

Solution :

Vérifier la configuration Redis (nbcio-boot-module-system/src/main/resources/application-dev.yml:150-161)
Tester la connexion Redis :

bash
1redis-cli -h 192.168.199.151 -p 6379 -a masterredis

Vérifier que Redis accepte les connexions externes (bind 0.0.0.0 ou adresse spécifique)

Problème 4 : Interface Swagger inaccessible

Symptôme : Erreur 404 sur http://localhost:8080/nbcio-boot/doc.html.

Cause : Swagger désactivé ou application non démarrée correctement.

Solution :

Vérifier que l'application est démarrée sans erreur dans les logs
Confirmer le context-path /nbcio-boot (nbcio-boot-module-system/src/main/resources/application-dev.yml:9-10)
Consulter la documentation officielle (README.md:58-62)

Prochaines étapes

Après avoir réussi à démarrer l'application, les étapes suivantes sont recommandées :

Explorer l'API : Utiliser Swagger UI (http://localhost:8080/nbcio-boot/doc.html) pour découvrir les endpoints disponibles et tester les fonctionnalités.
Configurer le frontend : Cloner et configurer le projet frontend Vue.js disponible sur https://gitee.com/nbacheng/nbcio-vue pour une expérience complète.
Personnaliser la configuration : Adapter les paramètres de sécurité, les connexions aux services externes (OSS Alibaba Cloud, Elasticsearch) selon les besoins (nbcio-boot-module-system/src/main/resources/application-dev.yml:198-208).
Explorer les fonctionnalités métier : Le projet inclut des modules de workflow Flowable, d'intégration DingTalk et de gestion ERP. Consulter la documentation officielle Jeecg pour approfondir ces aspects.
Rejoindre la communauté : Pour le support technique et les échanges, le groupe QQ 655054809 est disponible (README.md:64).