Meilleures pratiques de nommage
Stratégies de convention de nommage
Modèles de nommage cohérents
graph LR
A[Naming Strategy] --> B[Lowercase]
A --> C[Underscores]
A --> D[Descriptive]
A --> E[Consistent]
Type de format |
Exemple |
Description |
Basé sur le projet |
crm_users_db |
Inclut le contexte du projet |
Spécifique à l'environnement |
production_customer_db |
Indique l'environnement de déploiement |
Incluant une date |
users_20230615 |
Intègre des informations de date |
Exemples de code pour les meilleures pratiques
Utilitaire de nommage en Python
def generate_mongodb_name(project, environment, timestamp=False):
"""
Generate a standardized MongoDB database name
Args:
project (str): Project name
environment (str): Deployment environment
timestamp (bool): Include current timestamp
Returns:
str: Validated database name
"""
import datetime
## Basic validation
project = project.lower().replace(' ', '_')
environment = environment.lower()
## Construct database name
if timestamp:
current_date = datetime.datetime.now().strftime("%Y%m%d")
db_name = f"{project}_{environment}_{current_date}"
else:
db_name = f"{project}_{environment}"
return db_name
## Usage examples
print(generate_mongodb_name("Customer CRM", "production"))
print(generate_mongodb_name("User Management", "staging", timestamp=True))
Directives pratiques de nommage
À faire et à ne pas faire
graph TD
A[Naming Guidelines] --> B{Do}
A --> C{Don't}
B --> D[Use Lowercase]
B --> E[Use Underscores]
B --> F[Be Descriptive]
C --> G[Avoid Special Characters]
C --> H[No Spaces]
C --> I[Don't Start with Numbers]
Script de nommage MongoDB pour Ubuntu
#!/bin/bash
## MongoDB Naming Validation Script
## Function to validate database name
validate_mongodb_name() {
local db_name=$1
## Check length
if [ ${#db_name} -gt 64 ]; then
echo "Error: Name too long"
return 1
fi
## Check for invalid characters
if [[! $db_name =~ ^[a-z][a-z0-9_]*$ ]]; then
echo "Error: Invalid characters"
return 1
fi
echo "Valid database name: $db_name"
return 0
}
## Test cases
validate_mongodb_name "users_database"
validate_mongodb_name "2invalid_db"
validate_mongodb_name "user@database"
Conventions de nommage recommandées par LabEx
- Utilisez des lettres minuscules
- Séparez les mots avec des underscores
- Incluez le contexte (projet, environnement)
- Gardez les noms concis
- Évitez les mots-clés réservés
- Soyez cohérent dans tous les projets
Considérations avancées de nommage
- Utilisez des préfixes significatifs
- Incluez des indicateurs de version ou d'environnement
- Créez un document de norme de nommage
- Mettez en œuvre une validation automatisée
- Revoyez et mettez à jour périodiquement les conventions de nommage
En suivant ces meilleures pratiques, les développeurs peuvent créer des noms de bases de données MongoDB clairs, cohérents et faciles à maintenir, qui améliorent l'organisation et la lisibilité des projets.