1. [Forcé] Tous les noms liés à la programmation ne peuvent pas commencer par des soulignements ou des panneaux en dollars, et ils ne peuvent pas ne pas se terminer par des soulignements ou des panneaux en dollars. Contre-exemple: _name / __ nom / $ objet / name_ / name $ / objet $
2. [Obligatoire] Toutes les méthodes de dénomination liées à la programmation sont strictement interdites d'utiliser la méthode de mélanger le pinyin et l'anglais, et il n'est pas autorisé à utiliser directement le chinois. Remarque: l'orthographe et la grammaire anglaises correctes peuvent permettre aux lecteurs de comprendre et d'éviter l'ambiguïté. Notez que même des méthodes de dénomination pure de pinyin doivent être évitées.
Contre-exemple: dazhepromotion [recount] / getpingfenbyname () [note] / int variable = 3; Exemple positif: des noms communs internationaux tels que Ali / Alibaba / Taobao / Cainiao / Aliyun / Youku / Hangzhou peuvent être considérés comme anglais.
3. [Forcé] Le nom de classe utilise le style UpperCamelCase et doit suivre le formulaire de chameau, à des exceptions dans les cas suivants: (nommer pertinent du modèle de domaine) do / dto / vo / dao, etc.
Exemple positif: marcopolo / userdo / xmlservice / tcpudpdeal / tapromotion compteur Exemple: macropolo / userdo / xmlservice / tcpudpdeal / tapromotion
4. Les noms de méthodes [forcés], les noms de paramètres, les variables membres et les variables locales sont uniformément utilisés dans le style LowerCamelCase et doivent suivre la forme de chameau.
Exemple positif: localValue / gethttpMessage () / inputUserId
5. [Forcé] La dénomination constante est dans toutes les capitales, et les mots sont séparés par des soulignements, afin de s'efforcer d'exprimer la sémantique complètement et clairement, et ne pensent pas que le nom est long. Exemple positif: MAX_STOCK_COUNT COMPRENDRE Exemple: Max_Count
6. [forçage] La dénomination de classe abstraite commence par l'abstrait ou la base; La dénomination de la classe d'exception se termine par une exception; La dénomination de la classe de test commence par le nom de la classe qu'il doit tester et se terminer par le test.
7. [Forcés] Les supports font partie du type de tableau, et le tableau est défini comme suit: String [] args; Contre-exemple: n'utilisez pas d'args de chaîne [] pour définir
8. [Forcing] NE Ajouter pas est à une variable booléenne dans la classe POJO, sinon une analyse de framework provoquera des erreurs de sérialisation.
Contre-exemple: défini comme le type de données de base booléen émetteur; Propriété, sa méthode IssuCess (), RPC
Lorsque le framework se redevient, il "pense" que le nom d'attribut correspondant est le succès, ce qui fait que l'attribut ne peut être obtenu, puis lance une exception.
9. [forcés] Les noms de colis sont uniformément utilisés en minuscules, et il n'y a qu'un seul mot d'anglais sémantique naturel entre les séparateurs de points. Les noms de packages utilisent des formulaires singuliers, mais si le nom de classe a une signification plurielle, le nom de classe peut utiliser des formulaires pluriels.
Exemple positif: le nom du package de classe d'outils d'application est com.alibaba.mp.util, et le nom de classe est MessageUtils (cette règle fait référence à la structure du cadre du printemps)
10. [Forcé] Éliminez les abréviations complètement irrégulières et évitez de regarder le texte sans connaître le sens.
Contre-exemple: <un certain code commercial> «abréviation» abstractClass est nommé ABSCLASS; La condition "abréviation" est nommée con. Ces abréviations aléatoires réduisent sérieusement la lisibilité du code.
11. [Recommandé] Si le modèle de conception est utilisé, il est recommandé de refléter le modèle spécifique du nom de la classe.
Remarque: L'incarnation du modèle de conception dans le nom aidera les lecteurs à comprendre rapidement les idées de conception architecturale.
Exemple positif: Classe publique OrderFactory; Loginproxy de classe publique;
public classResourceObserver;
12. [Recommandé] n'ajoutez aucun modificateur aux méthodes et attributs dans les classes d'interface (pas non plus publiques), gardez la simplicité du code et ajoutez des commentaires Javadoc valides. Essayez de ne pas définir des variables dans l'interface. Si vous devez définir des variables, elles doivent être liées à la méthode d'interface et sont les constantes de base de l'ensemble de l'application.
Exemple positif: Méthode d'interface Signature: void f ();
La représentation constante de base de l'interface: String Company = "Alibaba";
Contre-exemple: Méthode d'interface Définition: abstrait public void f ();
Remarque: L'interface permet l'implémentation par défaut dans JDK8, donc cette méthode par défaut est une implémentation par défaut qui a une valeur pour toutes les classes d'implémentation.
13. Il existe deux ensembles de règles pour la dénomination des interfaces et des classes d'implémentation:
1) [obligatoire] Pour les classes de service et DAO, en fonction du concept de SOA, les services exposés doivent être des interfaces. Les classes de mise en œuvre internes utilisent le suffixe d'IMP et les interfaces.
L'exemple positif: CacheserviceImplt implémente l'interface de cache-service.
2) [recommandé] S'il s'agit d'un nom d'interface qui décrit la capacité, utilisez l'adjectif correspondant comme nom d'interface (généralement sous la forme de capable).
Exemple positif: AbstractTranslateur implémente traduisible.
14. [Référence] Il est recommandé d'avoir le suffixe d'énumération pour les noms de classe d'énumération. Les noms des membres de l'énumération doivent être entièrement capitalisés et séparés par des soulignements.
Remarque: l'énumération est en fait une classe constante spéciale, et le constructeur est obligé d'être privé par défaut.
Exemple: Nom de l'énumération: DealStatusEnum; Nom du membre: Success / Unkown_reason.
15. [Référence] Règlement de dénomination pour chaque couche:
A) Règlement sur la méthode de la couche de service / dao
1) La méthode pour obtenir un seul objet est préfixée avec GET.
2) La méthode pour obtenir plusieurs objets est préfixée avec la liste.
3) La méthode pour obtenir des valeurs statistiques est préfixée avec le nombre.
4) La méthode d'insertion est préfixée avec SAVE (recommandée) ou insert.
5) La méthode de suppression est préfixée avec Supprimer (recommandé) ou supprimer.
6) La méthode modifiée est préfixée avec la mise à jour.
B) Règlement de dénomination du modèle de domaine
1) Objet de données: xxxdo, xxx est le nom de la table de données.
2) Objet de transmission de données: xxxdto, xxx est le nom lié au domaine des affaires.
3) Affichage de l'objet: xxxvo, xxx est généralement le nom de la page Web.
4) Pojo est un terme général pour DO / DTO / BO / VO, et il est interdit d'être nommé xxxpojo.
1. [Forcé] Aucune valeur magique (c'est-à-dire les constantes non définies) ne peut apparaître directement dans le code.
COMPRERVANT: String key = "id # Taobao _" + TradeId; cache.put (clé, valeur);
2. [Forcé] Lorsque l'affectation initiale de longue ou longue, la majuscule L doit être utilisée et ne peut pas être minuscule l. Les minuscules sont facilement confondus avec le numéro 1, provoquant des malentendus.
Description: longa = 2l; Est-il écrit avec le numéro 21 ou le long type 2?
3. [Recommandé] n'utilisez pas de classe constante pour maintenir toutes les constantes. Il doit être classé en fonction de la fonction constante et maintenu séparément. Par exemple, les constantes liées au cache sont placées sous la classe: cacheConsts; Les constantes liées à la configuration du système sont placées sous la classe: configConsts.
Remarque: Une classe constante importante et complète doit être située à des constantes modifiées avec Ctrl + F, qui n'est pas propice à la compréhension et à la maintenance.
4. [Recommandé] Il existe cinq niveaux de réutilisation des constantes: les constantes partagées sur les applications, les constantes partagées dans les applications, les constantes partagées dans des sous-projets, les constantes partagées dans les packages et les constantes partagées dans les classes.
1) Constantes de partage de l'application croisée: placées dans la bibliothèque bipartite, généralement dans le répertoire const de client.jar.
2) Constantes de partage dans l'application: placées dans le répertoire Const dans les modules d'une bibliothèque.
Contre-exemple: les variables faciles à comprendre doivent également être définies comme des constantes partagées dans l'application. Les deux Siegemen ont défini des variables qui représentent "oui" en deux classes:
Dans la classe A: chaîne finale statique publique oui = "Oui"; Dans la classe B: chaîne finale statique publique oui = "y";
A.yes.equals (B.Yes), s'attendait à être vrai, mais revient en fait à False, provoquant des problèmes en ligne.
3) Constantes partagées dans le sous-projet: c'est-à-dire dans le répertoire const du sous-projet actuel.
4) Constantes partagées dans les packages: c'est-à-dire dans un répertoire constant de constant sous le package actuel.
5) Constantes partagées au sein de la classe: Définissez la finale statique privée directement à l'intérieur de la classe.
5. [Recommandé] Si la valeur variable change dans une seule plage, utilisez la classe Enum. S'il a également un attribut étendu autre que le nom, la classe Enum doit être utilisée. Le nombre dans l'exemple positif suivant est les informations d'extension, indiquant le jour de la semaine.
Exemples positifs: Énumération publique {lundi (1), mardi (2), mercredi (3), jeudi (4), vendredi (5),
Samedi (6), dimanche (7);}
1. Convention [forcée] sur l'utilisation des accolades. Si les accolades sont vides, alors il est simplement écrit comme {} sans casque de ligne; S'il s'agit d'un bloc de code non vide, alors:
1) Pas de rupture de ligne avant l'attelle gauche.
2) Apportez la ligne après l'attelle gauche.
3) Apportez avant l'attelle étroite.
4) S'il y a du code tel que sinon après l'attelle de clôture, il ne casse pas la ligne; Cela signifie que la ligne doit être rompue après la fin de l'attelle de clôture.
2. [Forcé] Il n'y a pas d'espace entre le support gauche et le caractère suivant; De même, il n'y a pas d'espace entre le support droit et le caractère précédent. Pour plus de détails, veuillez consulter les bons exemples de conseils ci-dessous l'article 5.
3. Des espaces [forcés] doivent être ajoutés entre des mots réservés tels que / pour / while / switch / do et supports gauche et droit.
4. [Forcé] Tout opérateur doit ajouter un espace à gauche et à droite.
Description: Les opérateurs incluent l'opérateur d'affectation =, l'opérateur logique &&, addition, soustraction, multiplication et symboles de division, caractères de fonctionnement trigonométrique, etc.
5. [Forcé] Le bloc de code est en retrait par 4 espaces. Si l'onglet est en retrait, veuillez le définir sur 1 Tab sur 4 espaces.
Exemple positif: (impliqué 1 à 5 points)
public static void main (String args []) {
// indent 4 espaces
String dit = "Bonjour";
// il doit y avoir un espace à gauche et à droite de l'opérateur
int flag = 0;
// Il doit y avoir un espace entre le mot-clé si et les supports, F et les supports de gauche dans les supports, et aucun espace n'est nécessaire pour 1 et les supports de fermeture si (drapeau == 0) {
System.out.println (Say);
}
// ajouter de l'espace avant l'auto-accolade gauche et n'enveloppez pas la ligne; Ajouter une ligne après l'attelle gauche
if (flag == 1) {
System.out.println ("monde");
// brise la ligne avant l'attelle de clôture, et il y a d'autre après l'attelle de clôture, il n'est donc pas nécessaire de briser la ligne
} autre{
System.out.println ("OK");
// En tant qu'aciette finale, vous devez envelopper la ligne
}
}
6. [Forcé] La limite du nombre de caractères en une seule ligne ne doit pas dépasser 120, ce qui dépasse la nécessité d'une nouvelle ligne. Lorsqu'une nouvelle ligne est rompue, les principes suivants sont suivis: 1) Lorsqu'une nouvelle ligne est brisée, 4 espaces sont en retrait par rapport à la ligne précédente.
2) Les opérateurs sont enveloppés du texte suivant.
3) Le symbole de point de l'appel de méthode est enveloppé du texte suivant.
4) Apporter des lignes après plusieurs paramètres est trop long et des virgules.
5) N'enroulez pas les lignes avant les supports, voir contre-exemples. Un exemple positif:
StringBuffer sb = new StringBuffer ();
// s'il y a plus de 120 caractères, la pause de ligne est en retrait par 4 espaces, et le symbole de points avant que la méthode ne soit rompue ensemble sb.append ("zi"). Ajouter ("xin")…
.APPEND ("Huang");
Contre-exemple:
StringBuffer sb = new StringBuffer ();
// s'il y a plus de 120 caractères, n'enveloppez pas la ligne avant les supports
SB.APPEND ("Zi"). Ajouter ("Xin"). Ajouter ... Ajouter
("Huang");
// Les appels de méthode avec de nombreux paramètres dépassent 120 caractères, et la méthode après la virgule est la méthode Newline (args1, args2, args3, ...
, argsx);
7. [Forcé] Lors de la définition et de la transmission des paramètres de méthode, plusieurs paramètres de virgules doivent être ajoutés avec des espaces après eux.
Par exemple: dans l'exemple suivant, le paramètre réel "A" doit avoir un espace après.
Méthode ("A", "B", "C");
8. [Recommandé] Il n'est pas nécessaire d'ajouter plusieurs espaces pour aligner les caractères d'une certaine ligne avec les caractères correspondants de la ligne précédente.
Un exemple positif:
int a = 3;
long b = 4l;
float c = 5f;
StringBuffer sb = new StringBuffer ();
Remarque: Si vous devez aligner la variable SB, vous devez ajouter quelques espaces à A, B et C. Dans le cas de plus de variables, c'est une chose lourde.
9. [Force] Le codage du fichier texte de l'IDE est défini sur UTF-8; Les caractères Newline des fichiers dans l'IDE sont au format UNIX et n'utilisent pas le format Windows.
10. [Recommandé] Insérez une ligne vierge entre les groupes d'instructions d'exécution, les groupes d'instructions de définition variable, différentes logiques métier ou différentes sémantiques dans l'organisme de la méthode. Il n'est pas nécessaire d'insérer des lignes vierges entre la même logique métier et la même sémantique.
Remarque: il n'est pas nécessaire d'insérer plusieurs rangées d'espaces pour les séparer.
1. [Forcé] Évitez d'accéder à de telles variables statiques ou méthodes statiques via des références d'objets d'une classe, qui ne nécessite pas d'augmenter le coût de résolution du compilateur et d'accès directement à l'aide du nom de classe.
2. [Forcé] Toutes les méthodes d'écrasement doivent être annotées avec @Override.
Contre-exemple: le problème de getObject () et Get0Bject (). L'un est O de la lettre et l'autre est 0 du nombre. L'ajout de @Override peut déterminer avec précision si la couverture est réussie. De plus, si la signature de la méthode est modifiée dans la classe abstraite, sa classe d'implémentation compilera immédiatement et rapportera une erreur.
3. [Forcé] uniquement avec le même type de paramètre et la même signification commerciale peut être utilisée par des paramètres de variable Java pour éviter d'utiliser l'objet.
Description: Les paramètres variables doivent être placés à la fin de la liste des paramètres. (Les gens sont encouragés à essayer de ne pas utiliser la programmation de paramètres variables)
Exemple positif: utilisateur public GetUsers (StringType, Integer ... IDS);
4. [Forcé] En principe, la signature de la méthode n'est pas autorisée à être modifiée pour éviter d'affecter l'appelant d'interface. L'interface est obsolète et doit être annotée @Deprecated et indiquer clairement ce que la nouvelle interface ou service est utilisé.
5. [Forcé] Les classes ou méthodes obsolètes ne peuvent pas être utilisées.
Description: La méthode Decode (StringEncodestr) dans java.net.urldecoder est obsolète et devrait utiliser le decode à double argument (Source de chaîne, stringencode). Étant donné que le fournisseur d'interface est clairement une interface obsolète, il est obligé de fournir une nouvelle interface en même temps; En tant qu'appelant, il est obligé de vérifier quelle est la nouvelle implémentation de la méthode obsolète.
6. [Forcer] La méthode égale de l'objet est susceptible de lancer des exceptions de pointeur vide, et les égaux doivent être appelés à l'aide de constantes ou d'objets qui déterminent la valeur.
Exemple positif: "test" .equals (objet);
Contre-exemple: object.equals ("test");
Remarque: il est recommandé d'utiliser java.util.objects # égaux (la classe d'outils introduite par JDK7)
7. [Forcing] Comparaison des valeurs entre tous les objets de wrapper du même type, tous sont comparés à l'aide de la méthode Equals.
Remarque: pour l'affectation de l'entier var =? Entre -128 et 127, l'objet entier est généré dans IntegerCache.cache, et les objets existants seront réutilisés. La valeur entière de cet intervalle peut être directement jugée à l'aide de ==, mais toutes les données en dehors de cet intervalle seront générées sur le tas et les objets existants ne seront pas réutilisés. C'est une grande fosse. Il est recommandé d'utiliser la méthode égale de jugement.
8. [Obligatoire] Les normes d'utilisation des types de données de base et des types de données d'emballage sont les suivantes:
1) Tous les attributs de classe POJO doivent utiliser le type de données de wrapper.
2) La valeur de retour et les paramètres de la méthode RPC doivent utiliser le type de données de wrapper.
3) Il est recommandé d'utiliser des types de données de base pour toutes les variables locales.
Remarque: L'attribut de classe POJO n'a pas de valeur initiale, ce qui rappelle à l'utilisateur qu'il doit explicitement attribuer des valeurs par lui-même lorsqu'il doit l'utiliser.
Les problèmes du NPE, ou inspection des stocks, sont garantis par l'utilisateur.
Exemple positif: le résultat de la requête de la base de données peut être nul, car il est automatiquement déballé, et la réception avec les types de données de base est risquée. CONTREREXAMPLE: Le rapport de transaction d'une certaine entreprise montre la hausse et la baisse du montant total de la transaction, c'est-à-dire Positive et négatif x%, x est le type de données de base. Lorsque l'appel est infructueux, la valeur par défaut est renvoyée et la page s'affiche: 0%, qui est déraisonnable et doit être affichée en tant que score mi-score. Par conséquent, la valeur nulle du type de données de wrapper peut représenter des informations supplémentaires, telles que: l'échec de l'appel distant et la sortie d'exception.
9. [Forced] Lors de la définition de classes POJO telles que DO / DTO / VO, ne définissez aucune valeur par défaut d'attribut.
Contre-exemple: la valeur par défaut de gmtcreate d'une entreprise est newDate (); Cependant, cette propriété ne place pas de valeur spécifique lors de l'extraction de données. Ce champ est mis à jour lors de la mise à jour d'autres champs, ce qui entraîne la modification du temps de création à l'heure actuelle.
10. [Forcé] Lors de l'ajout de nouveaux attributs à la classe de sérialisation, veuillez ne pas modifier le champ SerialVersionUid pour éviter l'échec de la désérialisation; Si la mise à niveau est complètement incompatible et évite le chaos de désérialisation, veuillez modifier la valeur SerialVersionuid.
Remarque: Notez que si SerialVersionUid est incohérent, une exception d'exécution de sérialisation sera lancée.
11. [Forcée] Toute logique commerciale est interdite d'être ajoutée à la méthode de construction. S'il y a une logique d'initialisation, veuillez le mettre dans la méthode init.
12. [Forcé] La méthode TOSTRING doit être écrite pour la classe POJO. Lorsque vous utilisez la Source de la classe d'outils> Générer ToString, si vous héritez d'une autre classe POJO, veuillez ajouter Super.Tostring devant.
Remarque: Lorsqu'une exception est lancée par l'exécution de la méthode, vous pouvez appeler directement la méthode ToString () de Pojo pour imprimer sa valeur d'attribut, ce qui est pratique pour le dépannage.
13. [Recommandé] Lorsque vous utilisez l'index pour accéder au tableau obtenu par la méthode Split de String, vous devez vérifier s'il y a du contenu après le dernier délimiteur, sinon il y aura un risque de lancer IndexoutOfBoundSexception.
illustrer:
String str = "a, b, c ,,"; String [] ary = str.split (",");
// le plus attendu de 3, le résultat est 3
System.out.println (ary.length);
14. [Recommandé] Lorsqu'une classe a plusieurs constructeurs ou plusieurs méthodes du même nom, ces méthodes doivent être placées ensemble afin de lire facile.
15. [Recommandé] L'ordre des définitions de méthode dans la classe est: Méthode publique ou méthode de protection> Méthode privée> Méthode Getter / Setter.
Remarque: Les méthodes publiques sont les méthodes les plus concernées pour les appelants de classe et les responsables, et le premier écran est mieux affiché; Bien que la méthode de protection ne concerne que les sous-classes, il peut également s'agir de la méthode de base sous le "mode de conception de modèle"; Bien que les méthodes privées n'aient généralement pas besoin d'être particulièrement concernées à l'extérieur et sont une mise en œuvre de la boîte noire; Étant donné que les informations de la méthode sont faibles, toutes les méthodes de service et de Getter / setter DAO sont placées à la fin du corps de classe.
16. [Recommandé] Dans la méthode du secteur, le nom du paramètre est le même que le nom de la variable du membre de la classe, ceci. Nom du membre = nom du paramètre. Dans la méthode Getter / Setter, essayez de ne pas augmenter la logique commerciale et d'augmenter la difficulté de dépannage des problèmes.
Contre-exemple:
public IntegerGetData () {if (true) {return data +100;
} else {return data- 100;
}}
17. [Recommandé] La méthode de connexion des chaînes dans le corps de la boucle est étendue à l'aide de la méthode d'ajout de StringBuilder.
Contre-exemple:
String str = "start"; pour (int i = 0; i <100; i ++) {str = str + "Bonjour";
}
Remarque: Le fichier bytecode décompilé montre que chaque boucle sera un nouvel objet StringBuilder, puis effectuera une opération d'ajout, et enfin renvoyer l'objet String via la méthode TOSTRING, provoquant un gaspillage de ressources de mémoire.
18. [Recommandé] Final peut améliorer l'efficacité de la réponse du programme et le déclarer comme final: 1) les variables qui ne nécessitent pas de réaffectation, y compris les attributs de classe et les variables locales.
2) Ajouter final avant les paramètres de l'objet, ce qui signifie que le pointeur de la référence n'est pas autorisé à être modifié.
3) La méthode de classe détermine qu'il n'est pas autorisé à être réécrit.
19. [recommandé] Utilisez la méthode du clone d'objet avec prudence pour copier des objets.
Remarque: La méthode de clone de l'objet est une copie peu profonde par défaut. Si vous souhaitez réaliser une copie profonde, vous devez réécrire la méthode du clone pour implémenter la copie de l'objet d'attribut.
20. [Recommandé] Les membres et les méthodes de classe ont un contrôle d'accès strict:
1) Si l'objet externe n'est pas autorisé à être créé directement via nouveau, le constructeur doit être privé.
2) La classe d'outils n'autorise pas les méthodes de constructeur public ou par défaut.
3) La classe n'est pas une variable de membre statique et est partagée avec la sous-classe et doit être protégée.
4) Les classes ne sont pas des variables de membres statiques et ne sont utilisées que dans cette classe et doivent être privées.
5) Si la variable de membre statique de classe n'est utilisée que dans cette classe, elle doit être privée.
6) S'il s'agit d'une variable de membre statique, il doit être considéré s'il est définitif.
7) Les méthodes des membres de la classe sont uniquement pour les appels internes de la classe et doivent être privés.
8) Les méthodes des membres de la classe ne sont exposées qu'aux classes héréditaires, elles sont donc limitées à protégées.
Description: Toute classe, méthode, paramètres, variables, contrôlez strictement la portée d'accès. La portée d'accès trop large n'est pas propice au découplage des modules. Penser: S'il s'agit d'une méthode privée, supprimez-le si vous souhaitez le supprimer. Mais si vous le supprimez, devez-vous transpirer un peu pendant vos paumes? Les variables sont comme vos propres enfants, essayez d'être à votre point de vue. La portée des variables est trop grande. Si vous courez sans restrictions, vous serez inquiet.
1. [Forcé] Lorsque la clé de MAP / SET est un objet personnalisé, HashCode et équivaut à être réécrit.
Exemple formel: la chaîne réécrit des méthodes HashCode et égal, afin que nous puissions utiliser des objets de chaîne très heureux comme clés.
2. [Forced] Le résultat du subliste de ArrayList ne peut être obligé d'arrayList, sinon une classcastException sera lancée: java.util.randomaccessssubist ne peut pas être jetée à java.util.arraylist; Remarque: Sublist renvoie le subliste de la classe intérieure de ArrayList, pas ArrayList, mais une vue d'ArrayList. Toutes les opérations sur le subliste subliste seront finalement reflétées sur la liste originale.
3. [Forcer] Dans le scénario de subliste, accordez une attention particulière à la modification du nombre d'éléments définis d'origine, ce qui entraînera la traversée, l'addition et la suppression du subliste pour générer des exceptions en conception concurrente-Modification.
4. [Forçage] à utiliser la méthode de conversion de collections en tableaux, vous devez utiliser le TOARRAY (T [] tableau) de la collection. Le tableau de types est passé est un tableau de la même taille, et la taille est list.size ().
CONTERNET-EXAMPLE: Il y a un problème avec l'utilisation directement de la méthode TOARRAY sans paramètres. La valeur de retour de cette méthode ne peut être que la classe objet []. Si vous convertissez avec force un autre type de tableau, une erreur ClassCastException se produira. Un exemple positif:
List <string> list = newArrayList <string> (2); list.add ("guan"); list.add ("bao");
String [] array = Newstring [list.size ()]; array = list.toArray (array);
Remarque: L'utilisation de la méthode du paramètre TOARRAY, lorsque l'espace de tableau alloué au paramètre n'est pas assez grand, la méthode TOARRAY réaffectera l'espace mémoire et renverra la nouvelle adresse de tableau; Si l'élément de tableau est supérieur à l'exigence réelle, l'élément de tableau a indiqué que [list.size ()] sera défini sur NULL et d'autres éléments du tableau conservent la valeur d'origine. Par conséquent, il est préférable de définir la méthode dans la taille du groupe de paramètres cohérente avec le nombre d'éléments définis.
5. [Forcé] Lors de la conversion d'un tableau en une collection à l'aide des tableaux de classe d'outils.aslist (), il ne peut pas l'utiliser pour modifier les méthodes liées à la collection. Sa méthode ADD / REPLOR / CLEAR mettra une exception non soutenue d'Exception.
Description: L'objet de retour d'Aslist est une classe interne des tableaux et n'implémente pas la méthode de modification de la collection. Arrays.aslist reflète le mode adaptateur, qui n'est qu'une interface de conversion, et les données en arrière-plan sont toujours un tableau.
String [] str = new String [] {"A", "B"};
List list = arrays.aslist (str);
Le premier cas: list.add ("c"); Exception d'exécution. Le deuxième cas: str [0] = "gujin"; alors list.get (0) sera également modifié en conséquence.
6. [forcé] Le caractère générique générique <? étend t> est utilisé pour recevoir les données renvoyées. La collection générique de cette méthode ne peut pas utiliser la méthode ADD. Remarque: Une fois la pomme emballée, elle renvoie un <? étend les fruits> objet. Cet objet ne peut ajouter aucun fruit, y compris les pommes.
7. [Forcé] Ne supprimez pas / ajouter les opérations des éléments dans la boucle FOREEAC. Veuillez utiliser la méthode Iterator pour supprimer l'élément. Si l'opération est simultanée, vous devez verrouiller l'objet Iterator.
Contre-exemple:
List <string> a = newArrayList <string> ();
a.add ("1");
A.Add ("2"); for (String temp: a) {if ("1" .equals (temp)) {
A.Remove (temp);
}
}
Remarque: Le résultat d'exécution de cet exemple sera au-delà des attentes de chacun. Donc, si vous essayez de remplacer "1" par "2", sera-ce le même résultat? Un exemple positif:
Iterator <string> it = a.iterator (); while (it.hasnext ()) {
String temp = it.next (); if (condition pour la suppression des éléments) {it.reMove ();
}
}
8. [Forcé] Sur la version JDK7 ou supérieure, le comparateur doit satisfaire la réflexivité, la transitivité et la symétrie, sinon les tableaux.Sort,
Collection.Sort rapportera une exception illégalargumentException.
illustrer:
1) Réflexivité: les résultats de comparaison de X et Y sont l'opposé des résultats de comparaison de Y et X.
2) Transmission: x> y, y> z, puis x> z.
3) Symétrie: x = y, alors le résultat de comparaison de x et z est le même que celui de y. Contre-exemple: L'exemple suivant ne gère pas l'égalité et une exception peut se produire lors d'une utilisation réelle:
Nouveau comparateur <Student> () {
@Override publicInt Compare (Student O1, Student O2) {return o1.getId ()> o2.getID ()? 1: -1; }
}
9. [Recommandé] Lors de l'initialisation d'une collection, essayez de spécifier la valeur initiale de la collection. Remarque: essayez d'initialiser ArrayList avec ArrayList (int initialCapacity) autant que possible.
10. [Recommandé] Utiliser le saisie pour traverser la collection de classe MAP KV, plutôt que la méthode de la touche pour la traversée.
Remarque: L'assemblage de la touche a réellement traversé deux fois, l'un est converti en un objet Iterator, et l'autre consiste à éliminer la valeur correspondant à la clé du hashmap. L'entrée vient de traverser une fois et met à la fois la clé et la valeur dans l'entrée, ce qui est plus efficace. S'il s'agit de JDK8, utilisez la méthode Map.ForEach.
Par exemple: valeurs () renvoie un ensemble de valeurs V, qui est un objet de collecte de liste; KeySet () Renvoie un jeu de valeur K, qui est un objet de collecte de set; EntrySet () Renvoie un ensemble de combinaison de valeur KV.
11. [Recommandé] Portez une grande attention à savoir si l'ensemble de classe de carte K / V peut stocker des valeurs nulles, comme indiqué dans le tableau suivant:
12. [Référence] Faites un usage rationnel de l'ordre et de la stabilité de l'ensemble pour éviter l'impact négatif du trouble et l'instabilité de l'ensemble.
Remarque: La stabilité signifie que l'ordre des éléments de l'ensemble est certain pour chaque traversée. L'ordre signifie que les résultats de la traversée sont organisés en séquence en fonction d'une règle de comparaison. Par exemple: ArrayList est Order / Unsort; Hashmap est sans ordre / un non-sort; Treeset est l'ordre / tri.
13. [Référence] En utilisant les caractéristiques uniques de l'élément de jeu, vous pouvez rapidement dédupliquer un autre ensemble, en évitant que l'utilisation de la méthode contient la méthode pour la déduplication de traversée.
1. [Forcé] Il est filial d'obtenir des objets singleton. Les opérations dans les objets singleton doivent également garantir la sécurité des filetages.
Remarque: Les classes, les classes d'outils et les cours d'usine Singleton doivent être prêts à faire attention.
2. [Forcé] Des ressources de thread doivent être fournies via des pools de threads, et il n'est pas autorisé à créer explicitement des threads dans l'application.
Remarque: L'avantage de l'utilisation de pools de threads est de réduire le temps consacré à la création et à la destruction des threads et aux frais généraux des ressources système, et à résoudre le problème des ressources insuffisantes. Si vous n'utilisez pas de pools de threads, cela peut amener le système à créer un grand nombre de threads similaires, ce qui entraîne une consommation de mémoire ou un "dépassement".
3. [Forcing] SimpledateFormat est une classe d'insécution thread. Il n'est généralement pas défini comme une variable statique. S'il est défini comme statique, il doit être verrouillé ou la classe d'outils DateUtils doit être utilisée.
Exemple positif: faites attention à la sécurité des filetages et à l'utilisation des DateUtils. Il est également recommandé de gérer ce qui suit:
Final Final statique privé <AteFormat> df = new ThreadLocal <AteFormat> () {
@Outrepasser
protégé dateFormat initialValue () {
return newsImpledateFormat ("yyyy-mm-dd");
}
};
Remarque: S'il s'agit d'une application JDK8, vous pouvez utiliser Instant au lieu de Date et LocalDateTime au lieu du calendrier.
DateTimeFormatter remplace SimpledateFormatter, l'explication officielle est la suivante: belle-sécurité immuable forte.
4. [Forcé] Lorsque la concurrence élevée est élevée, les appels synchrones devraient considérer la perte de performance du verrou. Si vous pouvez utiliser une structure de données sans verrouillage, n'utilisez pas de verrouillage; Si vous pouvez verrouiller les blocs, n'utilisez pas un corps de méthode entier; Si vous pouvez utiliser un verrou d'objet, n'utilisez pas de verrouillage de classe.
5. [Forcé] Lors du verrouillage des ressources multiples, des tables de base de données et des objets en même temps, une ordonnance de verrouillage cohérente est requise, sinon des blocages peuvent se produire.
Remarque: Le thread 1 doit verrouiller les tableaux A, B et C en séquence avant de mettre à jour les opérations peuvent être effectuées. Ensuite, l'ordre de verrouillage du fil 2 doit également être A, B et C, sinon des blocages peuvent se produire.
6. [Forced] Lors de la modification du même enregistrement simultanément, évitez la perte de mise à jour. Ajoutez des verrous sur la couche d'application, des verrouillage du cache, soit utilisez des verrous optimistes sur la couche de base de données, en utilisant la version comme base pour les mises à jour. Remarque: Si la probabilité de conflit par accès est inférieure à 20%, il est recommandé d'utiliser des serrures optimistes, sinon utilisez des serrures pessimistes. Le nombre de réchauffes de verrous optimistes ne doit pas être inférieur à 3 fois.
7. [Forcé] Lorsque les tâches chronométrées multi-threads sont traitées en parallèle, lorsque la minuterie exécute plusieurs calendriers, tant que l'une d'entre elles n'attrape pas l'exception lancée, les autres tâches se termineront automatiquement. Il n'y a aucun problème à utiliser ScheduleDexecutorService.
8. Les pools de threads [forcés] ne sont pas autorisés à être créés à l'aide d'exécuteurs, mais sont utilisés par ThreadPoolExecutor. Cette méthode de traitement permet aux étudiants qui écrivent pour définir plus clairement les règles de fonctionnement des pools de threads et éviter le risque d'épuisement des ressources.
Description: Inconvénients des méthodes d'exécuteurs:
1) newFixEdThreadpool et NewsingTheThreAdExEcutor: Le problème principal est que les files d'attente de traitement des demandes empilées peuvent consommer beaucoup de mémoire, même OOM.
2) NewCachedThreadpool et NewscheduledThreadpool: Le principal problème est que le nombre maximum de threads est Integer.max_value, qui peut créer un très grand nombre de threads, ou même OOM.
9. [Forced] Veuillez spécifier un nom de thread significatif lors de la création d'un pool de thread ou de thread pour faciliter le retour en arrière lorsqu'une erreur se produit.
Un exemple positif:
classe publique TimertAskThread étend Thread {PublicTiMtAskThread () {super.setName ("TimertAskThread"); …
}
10. [Recommandé] Utiliser CountdownLatch pour un fonctionnement asynchrone à synchrone. Chaque thread doit appeler la méthode du compte à rebours avant de quitter. Pay attention to catch exceptions when executing code to ensure that the countDown method can be executed, so as to avoid the main thread being unable to execute to the countDown method and not return the result until the timeout. Note: Note that the child thread throws an exception stack and cannot be tried-catched in the main thread.
11.【推荐】避免Random实例被多线程使用，虽然共享该实例是线程安全的，但会因竞争同一seed 导致的性能下降。说明：Random实例包括java.util.Random 的实例或者Math.random()实例。
正例：在JDK7之后，可以直接使用API ThreadLocalRandom，在JDK7之前，可以做到每个线程一个实例。
12. 【推荐】通过双重检查锁（double-checked locking）（在并发场景）实现延迟初始化的优化问题隐患(可参考The "Double-Checked Locking is Broken" Declaration),推荐问题解决方案中较为简单一种（适用于jdk5及以上版本），将目标属性声明为volatile型（比如反例中修改helper的属性声明为private volatile Helper helper= null;）；反例：
class Foo { private Helper helper = null; public Helper getHelper() {
if (helper ==null) synchronized(this) { if (helper== null) helper = newHelper();
} return helper; }
// other functions and members...
}
13.【参考】volatile解决多线程内存不可见问题。对于一写多读，是可以解决变量同步问题，但是如果多写，同样无法解决线程安全问题。如果想取回count++数据，使用如下类实现：
AtomicIntegercount = new AtomicInteger(); count.addAndGet(1); count++操作如果是
JDK8，推荐使用LongAdder对象，比AtomicLong性能更好（减少乐观锁的重试次数）。
14.【参考】注意HashMap的扩容死链，导致CPU飙升的问题。
15.【参考】ThreadLocal无法解决共享对象的更新问题，ThreadLocal对象建议使用static修饰。这个变量是针对一个线程内所有操作共有的，所以设置为静态变量，所有此类实例共享此静态变量，也就是说在类第一次被使用时装载，只分配一块存储空间，所有此类的对象(只要是这个线程内定义的)都可以操控这个变量。
1. 【强制】在一个switch块内，每个case要么通过break/return来终止，要么注释说明程序将继续执行到哪一个case为止；在一个switch块内，都必须包含一个default语句并且放在最后，即使它什么代码也没有。
2. 【强制】在if/else/for/while/do语句中必须使用大括号，即使只有一行代码，避免使用下面的形式：if (condition) statements;
3. 【推荐】推荐尽量少用else， if-else的方式可以改写成：
if(condition){ … return obj; }
// 接着写else的业务逻辑代码;
说明：如果使用要if-else if-else方式表达逻辑，【强制】请勿超过3层，超过请使用状态设计模式。
4. 【推荐】除常用方法（如getXxx/isXxx）等外，不要在条件判断中执行复杂的语句，以提高可读性。正例：
//伪代码如下
InputStream stream = file.open(fileName,"w");
if (stream != null) {
…
} 反例：
if (file.open(fileName, "w") != null)){
…
}
5. 【推荐】循环体中的语句要考量性能，以下操作尽量移至循环体外处理，如定义对象、变量、
获取数据库连接，进行不必要的try-catch操作（这个try-catch是否可以移至循环体外）。
6. 【推荐】接口入参保护，这种场景常见的是用于做批量操作的接口。
7. 【参考】方法中需要进行参数校验的场景：
1） 调用频次低的方法。
2） 执行时间开销很大的方法，参数校验时间几乎可以忽略不计，但如果因为参数错误导致中间执行回退，或者错误，那得不偿失。 3） 需要极高稳定性和可用性的方法。
4） 对外提供的开放接口，不管是RPC/API/HTTP接口。
8. 【参考】方法中不需要参数校验的场景：
1） 极有可能被循环调用的方法，不建议对参数进行校验。但在方法说明里必须注明外部参数检查。
2） 底层的方法调用频度都比较高，一般不校验。毕竟是像纯净水过滤的最后一道，参数错误不太可能到底层才会暴露问题。一般DAO层与Service层都在同一个应用中，部署在同一台服务器中，所以DAO的参数校验，可以省略。
3） 被声明成private只会被自己代码所调用的方法，如果能够确定调用方法的代码传入参数已经做过检查或者肯定不会有问题，此时可以不校验参数。
1. 【强制】类、类属性、类方法的注释必须使用javadoc规范，使用/**内容*/格式，不得使用
//xxx方式。
说明：在IDE编辑窗口中，javadoc方式会提示相关注释，生成javadoc可以正确输出相应注释；在IDE中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。
2. 【强制】所有的抽象方法（包括接口中的方法）必须要用javadoc注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。
说明：如有实现和调用注意事项，请一并说明。
3. 【强制】所有的类都必须添加创建者信息。
4. 【强制】方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/* */注释，注意与代码对齐。
5. 【强制】所有的枚举类型字段必须要有注释，说明每个数据项的用途。
6. 【推荐】与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词、关键字，保持英文原文即可。
反例：“TCP连接超时”解释成“传输控制协议连接超时”，理解反而费脑筋。
7. 【推荐】代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。
说明：代码与注释更新不同步，就像路网与导航软件更新不同步一样，如果导航软件严重滞后，就失去了导航的意义。
8. 【参考】注释掉的代码尽量要配合说明，而不是简单的注释掉。
说明：代码被注释掉有两种可能性：1）后续会恢复此段代码逻辑。2）永久不用。前者如果没有备注信息，难以知晓注释动机。后者建议直接删掉（代码仓库保存了历史代码）。
9. 【参考】对于注释的要求：第一、能够准确反应设计思想和代码逻辑；第二、能够描述业务含义，使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同天书，注释是给自己看的，即使隔很长时间，也能清晰理解当时的思路；注释也是给继任者看的，使其能够快速接替自己的工作。
10.【参考】好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是相当大的负担。
反例：
// put elephant into fridge put(elephant,fridge);
方法名put，加上两个有意义的变量名elephant和fridge，已经说明了这是在干什么，语义清晰的代码不需要额外的注释。
11.【参考】特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。 1） 待办事宜（TODO）:（ 标记人，标记时间，[预计处理时间]）
表示需要实现，但目前还未实现的功能。这实际上是一个javadoc的标签，目前的
javadoc还没有实现，但已经被广泛使用。只能应用于类，接口和方法（因为它是一个javadoc标签）。
2）错误，不能工作（FIXME）:（标记人，标记时间，[预计处理时间]）
在注释中用FIXME标记某代码是错误的，而且不能工作，需要及时纠正的情况。
1. 【强制】在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。
说明：不要在方法体内定义：Pattern pattern = Pattern.compile(规则);
2. 【强制】避免用Apache Beanutils进行属性的copy。
说明：Apache BeanUtils性能较差，可以使用其他方案比如SpringBeanUtils, Cglib
BeanCopier。
3. 【强制】velocity调用POJO类的属性时，建议直接使用属性名取值即可，模板引擎会自动按规范调用POJO的getXxx()，如果是boolean基本数据类型变量（注意，boolean命名不需要加is前缀），会自动调用isXxx()方法。
说明：注意如果是Boolean包装类对象，优先调用getXxx()的方法。
4. 【强制】后台输送给页面的变量必须加$!{var}――中间的感叹号。
说明：如果var=null或者不存在，那么${var}会直接显示在页面上。
5. 【强制】注意Math.random() 这个方法返回是double类型，注意取值范围0≤x<1（能够取到零值，注意除零异常），如果想获取整数类型的随机数，不要将x放大10的若干倍然后取整，直接使用Random对象的nextInt或者nextLong方法。
6. 【强制】获取当前毫秒数：System.currentTimeMillis(); 而不是new Date().getTime(); 说明：如果想获取更加精确的纳秒级时间值，用System.nanoTime。在JDK8中，针对统计时间等场景，推荐使用Instant类。
7. 【推荐】尽量不要在vm中加入变量声明、逻辑运算符，更不要在vm模板中加入任何复杂的逻辑。
8. 【推荐】任何数据结构的使用都应限制大小。
说明：这点很难完全做到，但很多次的故障都是因为数据结构自增长，结果造成内存被吃光。
9. 【推荐】对于“明确停止使用的代码和配置”，如方法、变量、类、配置文件、动态配置属性等要坚决从程序中清理出去，避免造成过多垃圾。清理这类垃圾代码是技术气场，不要有这样的观念：“不做不错，多做多错”。
1. 【强制】不要捕获Java类库中定义的继承自RuntimeException的运行时异常类，如：
IndexOutOfBoundsException/ NullPointerException，这类异常由程序员预检查来规避，保证程序健壮性。
正例：if(obj != null) {...}
反例：try { obj.method() }catch(NullPointerException e){…}
2. 【强制】异常不要用来做流程控制，条件控制，因为异常的处理效率比条件分支低。
3. 【强制】对大段代码进行try-catch，这是不负责任的表现。catch时请分清稳定代码和非稳定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的catch尽可能进行区分异常类型，再做对应的异常处理。
4. 【强制】捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，如果不想处理它，请将该异常抛给它的调用者。最外层的业务使用者，必须处理异常，将其转化为用户可以理解的内容。
5. 【强制】有try块放到了事务代码中，catch异常后，如果需要回滚事务，一定要注意手动回滚事务。
6. 【强制】finally块必须对资源对象、流对象进行关闭，有异常也要做try-catch。
说明：如果JDK7，可以使用try-with-resources方法。
7. 【强制】不能在finally块中使用return，finally块中的return返回后方法结束执行，不会再执行try块中的return语句。
8. 【强制】捕获异常与抛异常，必须是完全匹配，或者捕获异常是抛异常的父类。
说明：如果预期抛的是绣球，实际接到的是铅球，就会产生意外情况。
9. 【推荐】方法的返回值可以为null，不强制返回空集合，或者空对象等，必须添加注释充分说明什么情况下会返回null值。调用方需要进行null判断防止NPE问题。
说明：本规约明确防止NPE是调用者的责任。即使被调用方法返回空集合或者空对象，对调用者来说，也并非高枕无忧，必须考虑到远程调用失败，运行时异常等场景返回null的情况。
10.【推荐】防止NPE，是程序员的基本修养，注意NPE产生的场景：
1） 返回类型为包装数据类型，有可能是null，返回int值时注意判空。
反例：public int f(){return Integer对象}，如果为null，自动解箱抛NPE。
2） 数据库的查询结果可能为null。
3） 集合里的元素即使isNotEmpty，取出的数据元素也可能为null。
4） 远程调用返回对象，一律要求进行NPE判断。
5） 对于Session中获取的数据，建议NPE检查，避免空指针。
6） 级联调用obj.getA().getB().getC()；一连串调用，易产生NPE。
11.【推荐】在代码中使用“抛异常”还是“返回错误码”，对于公司外的http/api开放接口必须使用“错误码”；而应用内部推荐异常抛出；跨应用间RPC调用优先考虑使用Result方式，封装isSuccess、“错误码”、“错误简短信息”。
说明：关于RPC方法返回方式使用Result方式的理由：
1） 使用抛异常返回方式，调用方如果没有捕获到就会产生运行时错误。
2） 如果不加栈信息，只是new自定义异常，加入自己的理解的error message，对于调用端解决问题的帮助不会太多。如果加了栈信息，在频繁调用出错的情况下，数据序列化和传输的性能损耗也是问题。
12.【推荐】定义时区分unchecked / checked 异常，避免直接使用RuntimeException抛出，更不允许抛出Exception或者Throwable，应使用有业务含义的自定义异常。推荐业界已定义过的自定义异常，如：DaoException / ServiceException等。
13.【参考】避免出现重复的代码（Don'tRepeat Yourself），即DRY原则。
说明：随意复制和粘贴代码，必然会导致代码的重复，在以后需要修改时，需要修改所有的副本，容易遗漏。必要时抽取共性方法，或者抽象公共类，甚至是共用模块。
正例：一个类中有多个public方法，都需要进行数行相同的参数校验操作，这个时候请抽取：
private boolean checkParam(DTO dto){...}
1. 【强制】应用中不可直接使用日志系统（Log4j、Logback）中的API，而应依赖使用日志框架
SLF4J中的API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
private static final Logger logger =LoggerFactory.getLogger(Abc.class);
2. 【强制】日志文件推荐至少保存15天，因为有些异常具备以“周”为频次发生的特点。
3. 【强制】应用中的扩展日志（如打点、临时监控、访问日志等）命名方式：
appName_logType_logName.log。logType:日志类型，推荐分类有stats/desc/monitor/visit 等；logName:日志描述。这种命名的好处：通过文件名就可知道日志文件属于什么应用，什么
类型，什么目的，也有利于归类查找。
正例：mppserver应用中单独监控时区转换异常，如： mppserver_monitor_timeZoneConvert.log
说明：推荐对日志进行分类，错误日志和业务日志尽量分开存放，便于开发人员查看，也便于通过日志对系统进行及时监控。
4. 【强制】对trace/debug/info级别的日志输出，必须使用条件输出形式或者使用占位符的方式。
说明：logger.debug("Processingtrade with id: " + id + " symbol: " + symbol); 如果日志级别是warn，上述日志不会打印，但是会执行字符串拼接操作，如果symbol是对象，会执行toString()方法，浪费了系统资源，执行了上述操作，最终日志却没有打印。
正例：（条件）
if (logger.isDebugEnabled()) {
logger.debug("Processing trade with id: " +id + " symbol: " + symbol);
}
正例：（占位符）
logger.debug("Processing trade with id: {} andsymbol : {} ", id, symbol);
5. 【强制】避免重复打印日志，浪费磁盘空间，务必在log4j.xml中设置additivity=false。
正例：<loggername="com.taobao.ecrm.member.config" additivity="false">
6. 【强制】异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么往上抛。
正例：logger.error(各类参数或者对象toString +"_" + e.getMessage(), e);
7. 输出的POJO类必须重写toString方法，否则只输出此对象的hashCode值（地址值），没啥参考意义。
8. 【推荐】可以使用warn日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。注意日志输出的级别，error级别只记录系统逻辑出错、异常、或者重要的错误信息。如非必要，请不要在此场景打出error级别，避免频繁报警。
9. 【推荐】谨慎地记录日志。生产环境禁止输出debug日志；有选择地输出info日志；如果使用warn来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。
说明：大量地输出无效日志，不利于系统性能提升，也不利于快速定位错误点。纪录日志时请思考：这些日志真的有人看吗？看到这条日志你能做什么？能不能给问题排查带来好处？
10.【参考】如果日志用英文描述不清楚，推荐使用中文注释。对于中文UTF-8的日志，在secureCRT 中，set encoding=utf-8；如果中文字符还乱码，请设置：全局>默认的会话设置>外观>字体> 选择字符集gb2312；如果还不行，执行命令：set termencoding=gbk，并且直接使用中文来进行检索。
1. 【强制】表达是与否概念的字段，必须使用is_xxx的方式命名，数据类型是unsigned tinyint
（ 1表示是，0表示否），此规则同样适用于odps建表。
说明：任何字段如果为非负数，必须是unsigned。
2. 【强制】表名、字段名必须使用小写字母或数字；禁止出现数字开头，禁止两个下划线中间只出现数字。数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称需要慎重考虑。
正例：getter_admin，task_config，level3_name 反例：GetterAdmin，taskConfig，level_3_name
3. 【强制】表名不使用复数名词。
说明：表名应该仅仅表示表里面的实体内容，不应该表示实体数量，对应于DO类名也是单数形式，符合表达习惯。
4. 【强制】禁用保留字，如desc、range、match、delayed等，参考官方保留字。
5. 【强制】唯一索引名为uk_字段名；普通索引名则为idx_字段名。
说明：uk_即unique key；idx_ 即index的简称。
6. 【强制】小数类型为decimal，禁止使用float和double。
说明：float和double在存储的时候，存在精度损失的问题，很可能在值的比较时，得到不正确的结果。如果存储的数据范围超过decimal的范围，建议将数据拆成整数和小数分开存储。
7. 【强制】如果存储的字符串长度几乎相等，使用CHAR定长字符串类型。
8. 【强制】varchar是可变长字符串，不预先分配存储空间，长度不要超过5000，如果存储长度大于此值，定义字段类型为TEXT，独立出来一张表，用主键来对应，避免影响其它字段索引效率。
9. 【强制】表必备三字段：id, gmt_create, gmt_modified。
说明：其中id必为主键，类型为unsigned bigint、单表时自增、步长为1；分表时改为从
TDDL Sequence取值，确保分表之间的全局唯一。gmt_create,gmt_modified的类型均为date_time类型。
10.【推荐】表的命名最好是加上“业务名称_表的作用”，避免上云梯后，再与其它业务表关联时有混淆。
正例：tiger_task/ tiger_reader / mpp_config
11.【推荐】库名与应用名称尽量一致。
12.【推荐】如果修改字段含义或对字段表示的状态追加时，需要及时更新字段注释。
13.【推荐】字段允许适当冗余，以提高性能，但是必须考虑数据同步的情况。冗余字段应遵循：
1） 不是频繁修改的字段。
2） 不是varchar超长字段，更不能是text字段。
正例：各业务线经常冗余存储商品名称，避免查询时需要调用IC服务获取。
14.【推荐】单表行数超过500万行或者单表容量超过2GB，才推荐进行分库分表。
说明：如果预计三年后的数据量根本达不到这个级别，请不要在创建表时就分库分表。
反例：某业务三年总数据量才2万行，却分成1024张表，问：你为什么这么设计？答：分1024 张表，不是标配吗？
15.【参考】合适的字符存储长度，不但节约数据库表空间、节约索引存储，更重要的是提升检索速度。
正例：人的年龄用unsigned tinyint（表示范围0-255，人的寿命不会超过255岁）；海龟就必须是smallint，但如果是太阳的年龄，就必须是int；如果是所有恒星的年龄都加起来，那么就必须使用bigint。
1. 【强制】业务上具有唯一特性的字段，即使是组合字段，也必须建成唯一索引。
说明：不要以为唯一索引影响了insert速度，这个速度损耗可以忽略，但提高查找速度是明显的；另外，即使在应用层做了非常完善的校验和控制，只要没有唯一索引，根据墨菲定律，必然有脏数据产生。
2. 【强制】超过三个表禁止join。需要join的字段，数据类型保持绝对一致；多表关联查询时，保证被关联的字段需要有索引。
说明：即使双表join也要注意表索引、SQL性能。
3. 【强制】在varchar字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度。
说明：索引的长度与区分度是一对矛盾体，一般对字符串类型数据，长度为20的索引，区分度会高达90%以上，可以使用count(distinct left(列名, 索引长度))/count(*)的区分度来确定。
4. 【强制】页面搜索严禁左模糊或者全模糊，如果需要请走搜索引擎来解决。
说明：索引文件具有B-Tree的最左前缀匹配特性，如果左边的值未确定，那么无法使用此索引。
5. 【推荐】如果有order by的场景，请注意利用索引的有序性。order by 最后的字段是组合索引的一部分，并且放在索引组合顺序的最后，避免出现file_sort的情况，影响查询性能。
正例：where a=? and b=? order by c; 索引：a_b_c
反例：索引中有范围查找，那么索引有序性无法利用，如：WHERE a>10 ORDER BY b; 索引a_b 无法排序。
6. 【推荐】利用覆盖索引来进行查询操作，来避免回表操作。
说明：如果一本书需要知道第11章是什么标题，会翻开第11章对应的那一页吗？目录浏览一下就好，这个目录就是起到覆盖索引的作用。
正例：IDB能够建立索引的种类：主键索引、唯一索引、普通索引，而覆盖索引是一种查询的一种效果，用explain的结果，extra列会出现：using index.
7. 【推荐】利用延迟关联或者子查询优化超多分页场景。
说明：MySQL并不是跳过offset行，而是取offset+N行，然后返回放弃前offset行，返回N 行，那当offset特别大的时候，效率就非常的低下，要么控制返回的总页数，要么对超过特定阈值的页数进行SQL改写。
正例：先快速定位需要获取的id段，然后再关联：
SELECT a.* FROM 表1 a, (select id from表1 where 条件LIMIT 100000,20 ) bwhere a.id=b.id
8. [Recommended] The goal of SQL performance optimization: at least reach the range level, the requirement is the ref level, and if it can be consts, it is best. illustrer:
1） consts 单表中最多只有一个匹配行（主键或者唯一索引），在优化阶段即可读取到数据。
2） ref 指的是使用普通的索引。（normalindex）
3） range 对索引进范围检索。
反例：explain表的结果，type=index，索引物理文件全扫描，速度非常慢，这个index级别比较range还低，与全表扫描是小巫见大巫。
9. 【推荐】建组合索引的时候，区分度最高的在最左边。
正例：如果where a=? and b=? ，a列的几乎接近于唯一值，那么只需要单建idx_a索引即可。说明：存在非等号和等号混合判断条件时，在建索引时，请把等号条件的列前置。如：where a>?
and b=? 那么即使a的区分度更高，也必须把b放在索引的最前列。
10.【参考】创建索引时避免有如下极端误解：
1） 误认为一个查询就需要建一个索引。
2） 误认为索引会消耗空间、严重拖慢更新和新增速度。
3） 误认为唯一索引一律需要在应用层通过“先查后插”方式解决。
1. 【强制】不要使用count(列名)或count(常量)来替代count(*)，count(*)就是SQL92定义的标准统计行数的语法，跟数据库无关，跟NULL和非NULL无关。
说明：count(*)会统计值为NULL的行，而count(列名)不会统计此列为NULL值的行。
2. 【强制】count(distinct col) 计算该列除NULL之外的不重复数量。注意count(distinct col1, col2) 如果其中一列全为NULL，那么即使另一列有不同的值，也返回为0。
3. 【强制】当某一列的值全是NULL时，count(col)的返回结果为0，但sum(col)的返回结果为
NULL，因此使用sum()时需注意NPE问题。
正例：可以使用如下方式来避免sum的NPE问题：SELECTIF(ISNULL(SUM(g)),0,SUM(g)) FROM table;
4. 【强制】使用ISNULL()来判断是否为NULL值。注意：NULL与任何值的直接比较都为NULL。
illustrer:
1） NULL<>NULL的返回结果是NULL，不是false。
2） NULL=NULL的返回结果是NULL，不是true。
3） NULL<>1的返回结果是NULL，而不是true。
5. 【强制】在代码中写分页查询逻辑时，若count为0应直接返回，避免执行后面的分页语句。
6. 【强制】不得使用外键与级联，一切外键概念必须在应用层解决。
说明：（概念解释）学生表中的student_id是主键，那么成绩表中的student_id则为外键。
如果更新学生表中的student_id，同时触发成绩表中的student_id更新，则为级联更新。外键与级联更新适用于单机低并发，不适合分布式、高并发集群；级联更新是强阻塞，存在数据库更新风暴的风险；外键影响数据库的插入速度。
7. 【强制】禁止使用存储过程，存储过程难以调试和扩展，更没有移植性。
8. 【强制】IDB数据订正时，删除和修改记录时，要先select，避免出现误删除，确认无误才能提交执行。
9. 【推荐】in操作能避免则避免，若实在避免不了，需要仔细评估in后边的集合元素数量，控制在1000个之内。
10.【参考】因阿里巴巴全球化需要，所有的字符存储与表示，均以utf-8编码，那么字符计数方法注意：
illustrer:
SELECT LENGTH("阿里巴巴")； 返回为12
SELECT CHARACTER_LENGTH("阿里巴巴")； 返回为4
如果要使用表情，那么使用utfmb4来进行存储，注意它与utf-8编码。
11.【参考】TRUNCATE TABLE 比DELETE 速度快，且使用的系统和事务日志资源少，但TRUNCATE 无事务且不触发trigger，有可能造成事故，故不建议在开发代码中使用此语句。
说明：TRUNCATETABLE 在功能上与不带WHERE 子句的DELETE 语句相同。
1. 【强制】在表查询中，一律不要使用* 作为查询的字段列表，需要哪些字段必须明确写明。
说明：1）增加查询分析器解析成本。2）增减字段容易与resultMap配置不一致。
2. 【强制】POJO类的boolean属性不能加is，而数据库字段必须加is_，要求在resultMap中进行字段与属性之间的映射。
说明：参见定义POJO类以及数据库字段定义规定，在sql.xml增加映射，是必须的。
3. 【强制】不要用resultClass当返回参数，即使所有类属性名与数据库字段一一对应，也需要定义；反过来，每一个表也必然有一个与之对应。
说明：配置映射关系，使字段与DO类解耦，方便维护。
4. 【强制】xml配置中参数注意使用：#{}，#param#不要使用${} 此种方式容易出现SQL注入。
5. 【强制】iBATIS自带的queryForList(StringstatementName,int start,int size)不推荐使用。
说明：其实现方式是在数据库取到statementName对应的SQL语句的所有记录，再通过subList 取start,size的子集合，线上因为这个原因曾经出现过OOM。
正例：在sqlmap.xml中引入#start#, #size#
Map<String, Object> map = new HashMap<String,Object>(); map.put("start",start); map.put("size", size);
6. 【强制】不允许直接拿HashMap与HashTable作为查询结果集的输出。
反例：某同学为避免写一个<resultMap>，直接使用HashTable来接收数据库返回结果，结果出现日常是把bigint转成Long值，而线上由于数据库版本不一样，解析成BigInteger，导致线上问题。
7. 【强制】更新数据表记录时，必须同时更新记录对应的gmt_modified字段值为当前时间。
8. [Recommended] Don’t write a large and complete data update interface, pass it into the POJO class. Regardless of whether it is your own target update field or not, update table set c1=value1,c2=value2,c3=value3; C'est faux. When executing SQL, try not to update unchanged fields. First, it is prone to errors; second, it is inefficient; third, it is increased storage by binlog.
9. 【参考】@Transactional事务不要滥用。事务会影响数据库的QPS，另外使用事务的地方需要考虑各方面的回滚方案，包括缓存回滚、搜索引擎回滚、消息补偿、统计修正等。
10.【参考】<isEqual>中的compareValue是与属性值对比的常量，一般是数字，表示相等时带上此条件；<isNotEmpty>表示不为空且不为null时执行；<isNotNull>表示不为null值时执行。
1. 【推荐】图中默认上层依赖于下层，箭头关系表示可直接依赖，如：开放接口层可以依赖于
Web层，也可以直接依赖于Service层，依此类推：
• 开放接口层：可直接封装Service接口暴露成RPC接口；通过Web封装成http接口；网关控制层等。
• 终端显示层：各个端的模板渲染并执行显示层。当前主要是velocity渲染，JS渲染，JSP渲染，移动端展示层等。
• Web层：主要是对访问控制进行转发，各类基本参数校验，或者不复用的业务简单处理等。
• Service层：相对具体的业务逻辑服务层。
• Manager层：通用业务处理层，它有如下特征：
1） 对第三方平台封装的层，预处理返回结果及转化异常信息；
2） 对Service层通用能力的下沉，如缓存方案、中间件通用处理；
3） 与DAO层交互，对DAO的业务通用能力的封装。
• DAO层：数据访问层，与底层Mysql、Oracle、Hbase、OB进行数据交互。
• 外部接口或第三方平台：包括其它部门RPC开放接口，基础平台，其它公司的HTTP接口。
2. 【参考】（分层异常处理规约）在DAO层，产生的异常类型有很多，无法用细粒度异常进行
catch，使用catch(Exception e)方式，并throw newDaoException(e)，不需要打印日志，
因为日志在Manager/Service层一定需要捕获并打到日志文件中去，如果同台服务器再打日志，浪费性能和存储。在Service层出现异常时，必须记录日志信息到磁盘，尽可能带上参数信息，相当于保护案发现场。如果Manager层与Service同机部署，日志方式与DAO层处理一致，如果是单独部署，则采用与Service一致的处理方式。Web层绝不应该继续往上抛异常，因为已经处于顶层，无继续处理异常的方式，如果意识到这个异常将导致页面无法正常渲染，那么就应该直接跳转到友好错误页面，尽量加上友好的错误提示信息。开放接口层要将异常处理成错误码和错误信息方式返回。
3. 【参考】分层领域模型规约：
• DO（Data Object）：与数据库表结构一一对应，通过DAO层向上传输数据源对象。
• DTO（Data Transfer Object）：数据传输对象，Service和Manager向外传输的对象。
• BO（Business Object）：业务对象。可以由Service层输出的封装业务逻辑的对象。
• QUERY：数据查询对象，各层接收上层的查询请求。注：超过2个参数的查询封装，禁止使用Map类来传输。
• VO（View Object）：显示层对象，通常是Web向模板渲染引擎层传输的对象。
1. 【强制】定义GAV遵从以下规则：
1） GroupID格式：com.{公司/BU }.业务线.[子业务线]，最多4级。
说明：{公司/BU}例如：alibaba/taobao/tmall/aliexpress等BU一级；子业务线可选。
正例：com.taobao.tddl 或com.alibaba.sourcing.multilang
2） ArtifactID格式：产品线名-模块名。语义不重复不遗漏，先到仓库中心去查证一下。
正例：tc-client / uic-api / tair-tool
3） Version：详细规定参考下方。
2. 【强制】二方库版本号命名方式：主版本号.次版本号.修订号
1） 主版本号：当做了不兼容的API 修改，或者增加了能改变产品方向的新功能。
2） 次版本号：当做了向下兼容的功能性新增（新增类、接口等）。
3） 修订号：修复bug，没有修改方法签名的功能加强，保持API 兼容性。
3. 【强制】线上应用不要依赖SNAPSHOT版本（安全包除外）；正式发布的类库必须使用RELEASE 版本号升级+1的方式，且版本号不允许覆盖升级，必须去中央仓库进行查证。
说明：不依赖SNAPSHOT版本是保证应用发布的幂等性。另外，也可以加快编译时的打包构建。
4. 【强制】二方库的新增或升级，保持除功能点之外的其它jar包仲裁结果不变。如果有改变，必须明确评估和验证，建议进行dependency:resolve前后信息比对，如果仲裁结果完全不一致，那么通过dependency:tree命令，找出差异点，进行<excludes>排除jar包。
5. 【强制】二方库里可以定义枚举类型，参数可以使用枚举类型，但是接口返回值不允许使用枚举类型或者包含枚举类型的POJO对象。
6. 【强制】依赖于一个二方库群时，必须定义一个统一版本变量，避免版本号不一致。
说明：依赖springframework-core,-context,-beans，它们都是同一个版本，可以定义一个变量来保存版本：${spring.version}，定义依赖的时候，引用该版本。
7. 【强制】禁止在子项目的pom依赖中出现相同的GroupId，相同的ArtifactId，但是不同的
Version.
说明：在本地调试时会使用各子项目指定的版本号，但是合并成一个war，只能有一个版本号出现在最后的lib目录中。曾经出现过线下调试是正确的，发布到线上出故障的先例。
8. 【推荐】工具类二方库已经提供的，尽量不要在本应用中编程实现。
l json操作： fastjson
l md5操作：commons-codec
l 工具集合：Guava包
l 数组操作：ArrayUtils（org.apache.commons.lang3.ArrayUtils）
l 集合操作：CollectionUtils(org.apache.commons.collections4.CollectionUtils)
l 除上面以外还有NumberUtils、DateFormatUtils、DateUtils等优先使用org.apache.commons.lang3这个包下的，不要使用org.apache.commons.lang包下面的。原因是commons.lang这个包是从JDK1.2开始支持的所以很多1.5/1.6的特性是不支持的，例如：泛型。
9. 【推荐】所有pom文件中的依赖声明放在<dependencies>语句块中，所有版本仲裁放在
<dependencyManagement>语句块中。
说明：<dependencyManagement>里只是声明版本，并不实现引入，因此子项目需要显式的声明依赖，version和scope都读取自父pom。而<dependencies>所有声明在主pom的<dependencies > 里的依赖都会自动引入，并默认被所有的子项目继承。
10.【推荐】二方库尽量不要有配置项，最低限度不要再增加配置项。
11.【参考】为避免应用二方库的依赖冲突问题，二方库发布者应当遵循以下原则：
1） 精简可控原则。移除一切不必要的API和依赖，只包含Service API、必要的领域模型对象、Utils类、常量、枚举等。如果依赖其它二方库，尽量是provided引入，让二方库使用者去依赖具体版本号；无log具体实现，只依赖日志框架。
2） 稳定可追溯原则。每个版本的变化应该被记录，二方库由谁维护，源码在哪里，都需要能方便查到。除非用户主动升级版本，否则公共二方库的行为不应该发生变化。
1. 【推荐】高并发服务器建议调小TCP协议的time_wait超时时间。
说明：操作系统默认240秒后，才会关闭处于time_wait状态的连接，在高并发访问下，服务器端会因为处于time_wait的连接数太多，可能无法建立新的连接，所以需要在服务器上调小此等待值。
正例：在linux服务器上请通过变更/etc/sysctl.conf文件去修改该缺省值（秒）： net.ipv4.tcp_fin_timeout = 30
2. 【推荐】调大服务器所支持的最大文件句柄数（File Descriptor，简写为fd）。
说明：主流操作系统的设计是将TCP/UDP连接采用与文件一样的方式去管理，即一个连接对应于一个fd。主流的linux服务器默认所支持最大fd数量为1024，当并发连接数很大时很容易因为fd不足而出现“open too many files”错误，导致新的连接无法建立。建议将linux 服务器所支持的最大句柄数调高数倍（与服务器的内存数量相关）。
3. 【推荐】给JVM设置-XX:+HeapDumpOnOutOfMemoryError参数，让JVM碰到OOM场景时输出dump 信息。
说明：OOM的发生是有概率的，甚至有规律地相隔数月才出现一例，出现时的现场信息对查错非常有价值。
4. 【参考】服务器内部重定向必须使用forward；外部重定向地址必须使用URL Broker生成，否则因线上采用HTTPS协议而导致浏览器提示“不安全”。此外，还会带来URL维护不一致的问题。
1. 【强制】可被用户直接访问的功能必须进行权限控制校验。说明：防止没有做权限控制就可随意访问、操作别人的数据，比如查看、修改别人的订单。
2. 【强制】用户敏感数据禁止直接展示，必须对展示数据脱敏。说明：支付宝中查看个人手机号码会显示成:158****9119，隐藏中间4位，防止隐私泄露。
3. 【强制】用户输入的SQL参数严格使用参数绑定或者METADATA字段值限定，防止SQL注入，禁止字符串拼接SQL访问数据库。
4. 【强制】用户请求传入的任何参数必须做有效性验证。说明：忽略参数校验可能导致：
l page size过大导致内存溢出
l 恶意order by导致数据库慢查询
l 正则输入源串拒绝服务ReDOS
l 任意重定向
l SQL注入
l Shell注入
l 反序列化注入
5. 【强制】禁止向HTML页面输出未经安全过滤或未正确转义的用户数据。
6. 【强制】表单、AJAX提交必须执行CSRF安全过滤。
说明：CSRF(Cross-siterequest forgery)跨站请求伪造是一类常见编程漏洞。对于存在CSRF
漏洞的应用/网站，攻击者可以事先构造好URL，只要受害者用户一访问，后台便在用户不知情情况下对数据库中用户参数进行相应修改。
7. 【强制】URL外部重定向传入的目标地址必须执行白名单过滤。
正例：
try{ if(com.alibaba.fasttext.sec.url.CheckSafeUrl
.getDefaultInstance().inWhiteList(targetUrl)){ response.sendRedirect(targetUrl);
}
} catch (IOException e){ logger.error("Check returnURL error! targetURL=" + targetURL,e); throwe;
8. 【强制】Web应用必须正确配置Robots文件，非SEO URL必须配置为禁止爬虫访问。
User-agent: * Disallow: /
9. 【强制】在使用平台资源，譬如短信、邮件、电话、下单、支付，必须实现正确的防重放限制，如数量限制、疲劳度控制、验证码校验，避免被滥刷、资损。
说明：如注册时发送验证码到手机，如果没有限制次数和频率，那么可以利用此功能骚扰到其它用户，并造成短信平台资源浪费。
10.【推荐】发贴、评论、发送即时消息等用户生成内容的场景必须实现防刷、文本内容违禁词过滤等风控策略。
建议下载官方的pdf格式更利于学习与阅读：//www.VeVB.COm/books/592610.html