Comment refactoriser, corriger et optimiser cette fonction de remplacement de caractères dans java

Question

Lors de l'optimisation de l'application, j'ai trouvé cette routine qui supprime la chaîne XML des balises CDATA et remplace certains caractères par des références de caractères pour les afficher dans une page HTML.

La routine est moins que parfaite; il laissera de l'espace de fin et rompra avec l'exception StringOutOfBounds s'il y a un problème avec le XML.

J'ai créé quelques tests unitaires lorsque j'ai commencé à travailler sur le routage, mais la fonctionnalité actuelle peut être améliorée, donc ceux-ci servent davantage de référence.

La routine a besoin d'être refactorisée pour des raisons de santé mentale. Mais, la vraie raison pour laquelle je dois corriger cette routine est d'améliorer une performance. Il est devenu un sérieux goulot d'étranglement dans l'application.

package engine; 

import junit.framework.Assert; 
import junit.framework.TestCase; 

public class StringFunctionsTest extends TestCase { 

    public void testEscapeXMLSimple(){ 
     final String simple = "<xml><SvcRsData>a<![CDATA[<sender>John & Smith</sender>]]></SvcRsData></xml> ";  
     final String expected = "<xml><SvcRsData>a&#60;sender&#62;John &#38; Smith&#60;/sender&#62;</SvcRsData></xml> "; 
     String result = StringFunctions.escapeXML(simple); 
     Assert.assertTrue(result.equals(expected)); 
    } 

    public void testEscapeXMLCDATAInsideCDATA(){ 
     final String stringWithCDATAInsideCDATA = "<xml><SvcRsData>a<![CDATA[<sender>John <![CDATA[Inner & CD ]]>& Smith</sender>]]></SvcRsData></xml> ";  
     final String expected = "<xml><SvcRsData>a&#60;sender&#62;John &#60;![CDATA[Inner &#38; CD & Smith</sender>]]></SvcRsData></xml> "; 
     String result = StringFunctions.escapeXML(stringWithCDATAInsideCDATA);  
     Assert.assertTrue(result.equals(expected)); 
    } 

    public void testEscapeXMLCDATAWithoutClosingTag(){  
     final String stringWithCDATAWithoutClosingTag = "<xml><SvcRsData>a<![CDATA[<sender>John & Smith</sender></SvcRsData></xml> "; 
     try{ 
      String result = StringFunctions.escapeXML(stringWithCDATAWithoutClosingTag); 
     }catch(StringIndexOutOfBoundsException exception){ 
      Assert.assertNotNull(exception); 
     } 
    } 

    public void testEscapeXMLCDATAWithTwoCDATAClosingTags(){   
     final String stringWithCDATAWithTwoClosingTags = "<xml><SvcRsData>a<![CDATA[<sender>John Inner & CD ]]>& Smith</sender>]]>bcd & efg</SvcRsData></xml> ";   
     final String expectedAfterSecondClosingTagNotEscaped = "<xml><SvcRsData>a&#60;sender&#62;John Inner &#38; CD & Smith</sender>]]>bcd & efg</SvcRsData></xml> "; 
     String result = StringFunctions.escapeXML(stringWithCDATAWithTwoClosingTags); 
     Assert.assertTrue(result.equals(expectedAfterSecondClosingTagNotEscaped)); 
    } 

    public void testEscapeXMLSimpleTwoCDATA(){ 
     final String stringWithTwoCDATA = "<xml><SvcRsData>a<![CDATA[<sender>John & Smith</sender>]]>abc<sometag>xyz</sometag><sometag2><![CDATA[<recipient>Gorge & Doe</recipient>]]></sometag2></SvcRsData></xml> ";  
     final String expected = "<xml><SvcRsData>a&#60;sender&#62;John &#38; Smith&#60;/sender&#62;abc<sometag>xyz</sometag><sometag2>&#60;recipient&#62;Gorge &#38; Doe&#60;/recipient&#62;</sometag2></SvcRsData></xml> "; 
     String result = StringFunctions.escapeXML(stringWithTwoCDATA); 
     Assert.assertTrue(result.equals(expected)); 
    } 

    public void testEscapeXMLOverlappingCDATA(){ 
     final String stringWithTwoCDATA = "<xml><SvcRsData>a<![CDATA[<sender>John & <![CDATA[Smith</sender>]]>abc<sometag>xyz</sometag><sometag2><recipient>Gorge & Doe</recipient>]]></sometag2></SvcRsData></xml> ";  
     final String expectedMess = "<xml><SvcRsData>a&#60;sender&#62;John &#38; &#60;![CDATA[Smith&#60;/sender&#62;abc<sometag>xyz</sometag><sometag2><recipient>Gorge & Doe</recipient>]]></sometag2></SvcRsData></xml> "; 
     String result = StringFunctions.escapeXML(stringWithTwoCDATA); 
     Assert.assertTrue(result.equals(expectedMess)); 
    } 

} 

---

C'est la fonction:

package engine; 

public class StringFunctions { 

    public static String escapeXML(String s) { 
     StringBuffer result = new StringBuffer(); 
     int stringSize = 0; 
     int posIniData = 0, posFinData = 0, posIniCData = 0, posFinCData = 0; 
     String stringPreData = "", stringRsData = "", stringPosData = "", stringCData = "", stringPreCData = "", stringTempRsData = ""; 
     String stringNewRsData = "", stringPosCData = "", stringNewCData = ""; 
     short caracter; 

     stringSize = s.length(); 
     posIniData = s.indexOf("<SvcRsData>"); 
     if (posIniData > 0) { 
      posIniData = posIniData + 11; 
      posFinData = s.indexOf("</SvcRsData>"); 
      stringPreData = s.substring(0, posIniData); 
      stringRsData = s.substring(posIniData, posFinData); 
      stringPosData = s.substring(posFinData, stringSize); 
      stringTempRsData = stringRsData; 
      posIniCData = stringRsData.indexOf("<![CDATA["); 
      if (posIniCData > 0) { 
       while (posIniCData > 0) { 
        posIniCData = posIniCData + 9; 
        posFinCData = stringTempRsData.indexOf("]]>"); 
        stringPreCData = stringTempRsData.substring(0, 
          posIniCData - 9); 
        stringCData = stringTempRsData.substring(posIniCData, 
          posFinCData); 
        stringPosCData = stringTempRsData.substring(
          posFinCData + 3, stringTempRsData.length()); 

        stringNewCData = replaceCharacter(stringCData); 
        stringTempRsData = stringTempRsData.substring(
          posFinCData + 3, stringTempRsData.length()); 
        stringNewRsData = stringNewRsData + stringPreCData 
          + stringNewCData; 
        posIniCData = stringTempRsData.indexOf("<![CDATA["); 
       } 
      } else { 
       stringNewRsData = stringRsData; 
      } 
      stringNewRsData = stringNewRsData + stringPosCData; 
      s = stringPreData + stringNewRsData + stringPosData; 
      stringSize = s.length(); 
     } 

     for (int i = 0; i < stringSize; i++) { 
      caracter = (short) s.charAt(i); 
      if (caracter > 128) { 
       result.append("&#"); 
       result.append(caracter); 
       result.append(';'); 
      } else { 
       result.append((char) caracter); 
      } 
     } 
     return result.toString(); 

    } 

    private static String replaceCharacter(String s) { 
     StringBuffer result = new StringBuffer(); 
     int stringSize = s.length(); 
     short caracter; 

     for (int i = 0; i < stringSize; i++) { 

      caracter = (short) s.charAt(i); 
      if (caracter > 128 || caracter == 34 || caracter == 38 
        || caracter == 60 || caracter == 62) { 
       result.append("&#"); 
       result.append(caracter); 
       result.append(';'); 
      } else { 
       result.append((char) caracter); 
      } 
     } 
     return result.toString(); 

    } 

} 

Answer 1

Jetez un oeil à la StringEscapeUtils Class de Apache Commons. Il contient une méthode escapeXML.

Answer 2

il me semble que vous faites quelque chose qui a déjà été fait auparavant, probablement en commun apache.

Votre fonction est tellement alambiquée que je ne sais pas si vous êtes vraiment 'escapeXML' ou quelque chose de plus. Si tout ce que vous faites est d'échapper xml, alors vous devriez google pour une meilleure mise en œuvre.

Answer 3

Jetez un oeil à StringEscapeUtils de Apache Commons. Cela a des fonctions pour échapper/unescape XML/HTML fiable.