Configuration de l'environnement

Il peut être très utile de disposer de différentes configurations en fonction de l’environnement de l’application. Par exemple, la configuration de l’environnement vous permet de personnaliser les stratégies de script, de remplacer les styles de document par une feuille de style définie par l’utilisateur ou de gérer les requêtes web. Pour faciliter cette tâche, Aspose.HTML for Java propose la classe Configuration spécialement conçue pour répondre à ces exigences. En utilisant l’objet Configuration, vous pouvez sans effort adapter le comportement de votre application Java à vos besoins spécifiques.

Sandboxing

Un ensemble de drapeaux de sandboxing est un ensemble de zéro ou plusieurs drapeaux qui limitent les capacités des ressources potentiellement non fiables. Un bac à sable fournit un environnement d’exécution sûr et contrôlé en isolant le code potentiellement malveillant ou non fiable du système sous-jacent et des données sensibles.

L’exemple Java suivant montre comment convertir un document HTML au format PDF et appliquer des restrictions de sandboxing – comment marquer Scripts comme une ressource non fiable. En conséquence, Scripts sera désactivé pendant l’exécution de l’application.

// How to disable scripts for HTML to PDF conversion using Java

// Prepare HTML code and save it to a file
String code = "<span>Hello, World!!</span>\n" +
        "<script>document.write('Have a nice day!');</script>\n";

try (java.io.FileWriter fileWriter = new java.io.FileWriter("sandboxing.html")) {
    fileWriter.write(code);
}

// Create an instance of the Configuration class
Configuration configuration = new Configuration();

// Mark 'scripts' as an untrusted resource
configuration.setSecurity(com.aspose.html.Sandbox.Scripts);

// Initialize an HTML document with specified configuration
HTMLDocument document = new HTMLDocument("sandboxing.html", configuration);

// Convert HTML to PDF
Converter.convertHTML(document, new PdfSaveOptions(), "sandboxing_out.pdf");

Dans l’exemple, une nouvelle instance de la classe Configuration est créée pour configurer le bac à sable. La méthode setSecurity() est appelée sur l’objet configuration, en passant com.aspose.html.Sandbox.Scripts comme argument. Ce drapeau active le sandboxing et restreint l’exécution des scripts dans le document HTML.

Service d’agent utilisateur – User Agent Service

Toutes les fonctions importantes sont regroupées dans des services distincts à des fins de convivialité et se trouvent dans le paquet com.aspose.html.services. Dans le contexte de la configuration de l’environnement, le Service de l’agent utilisateur vous permet de spécifier une feuille de style utilisateur personnalisée, un jeu de caractères principal pour le document, ainsi que des paramètres de langue et de polices.

Feuille de style de l’utilisateur – User Style Sheet

L’utilisateur peut spécifier des informations de style personnalisées pour un document particulier. Ces informations s’appliquent au document conformément aux règles de cascade et peuvent affecter la présentation du document. L’extrait de code Java suivant illustre l’utilisation du service d’agent utilisateur ( IUserAgentService) pour appliquer une feuille de style personnalisée à un document HTML qui est ensuite converti en PDF.

Examinons simplement les étapes nécessaires pour spécifier une feuille de style personnalisée dans un document HTML :

1. Dans l’exemple, nous utilisons le constructeur Configuration() pour créer une instance de la classe Configuration.
2. Ensuite, nous appelons la méthode getService() de la classe Configuration et lui passons la classe IUserAgentService.class comme paramètre. Nous obtenons ainsi une instance du User Agent Service.
3. Pour définir une feuille de style utilisateur personnalisée à appliquer au document HTML, nous utilisons la méthode setUserStyleSheet() du User Agent Service, en fournissant un code CSS comme argument. Dans ce cas, la règle CSS span { color : green ; } est utilisée pour que tous les éléments <span> affichent le texte en vert.

// Apply a custom user stylesheet to HTML content and convert it to PDF using Java

// Prepare HTML code and save it to a file
String code = "<span>Hello, World!!!</span>";

try (java.io.FileWriter fileWriter = new java.io.FileWriter("user-agent-stylesheet.html")) {
    fileWriter.write(code);
}

// Create an instance of the Configuration class
Configuration configuration = new Configuration();

// Get the IUserAgentService
IUserAgentService userAgent = configuration.getService(IUserAgentService.class);

// Set a custom color to the <span> element
userAgent.setUserStyleSheet("span { color: green; }");

// Initialize an HTML document with specified configuration
HTMLDocument document = new HTMLDocument("user-agent-stylesheet.html", configuration);

// Convert HTML to PDF
Converter.convertHTML(document, new PdfSaveOptions(), "user-agent-stylesheet_out.pdf");

Jeu de caractères – Character Set

Afin d’analyser et d’afficher correctement un document HTML, l’application doit connaître le jeu de caractères (encodage) utilisé pour le document. Si l’encodage des caractères n’est pas directement spécifié dans l’en-tête du document, Aspose.HTML utilise UTF-8, qui est défini comme l’encodage par défaut pour la spécification HTML5. Cependant, si vous êtes sûr que votre document HTML est écrit différemment de l’encodage UTF-8, vous pouvez le spécifier manuellement. Examinons les étapes nécessaires pour spécifier un jeu de caractères (encodage) dans le document HTML :

1. Créer une instance de la classe Configuration.
2. Utilisez la méthode getService() pour obtenir une instance du User Agent Service. La méthode prend en paramètre la classe IUserAgentService.class.
3. Appelez la méthode setCharSet() du User Agent Service et indiquez le jeu de caractères (encodage) souhaité. Dans cet exemple, ISO-8859-1 est défini comme jeu de caractères.

// Set User Agent charset to ISO-8859-1 and convert HTML to PDF using Java

// Prepare HTML code and save it to a file
String code = "<h1>Character Set</h1>\r\n" +
        "<p>The <b>CharSet</b> property sets the primary character-set for a document.</p>\r\n";

try (java.io.FileWriter fileWriter = new java.io.FileWriter("user-agent-charset.html")) {
    fileWriter.write(code);
}

// Create an instance of the Configuration class
Configuration configuration = new Configuration();

// Get the IUserAgentService
IUserAgentService userAgent = configuration.getService(IUserAgentService.class);

// Set ISO-8859-1 encoding to parse the document
userAgent.setCharSet("ISO-8859-1");

// Initialize an HTML document with specified configuration
HTMLDocument document = new HTMLDocument("user-agent-charset.html", configuration);

// Convert HTML to PDF
Converter.convertHTML(document, new PdfSaveOptions(), "user-agent-charset_out.pdf");

En définissant le jeu de caractères à l’aide de la méthode setCharSet(), l’application informe le moteur d’analyse et de rendu Aspose.HTML for Java de l’encodage spécifique utilisé dans le document HTML. C’est très important car des jeux de caractères différents peuvent représenter les caractères différemment, et sans les informations d’encodage correctes, le document peut ne pas être analysé ou affiché correctement.

Définir le chemin d’accès au dossier des polices

L’une des principales caractéristiques d’Aspose.HTML est sa capacité à travailler avec des polices personnalisées, ce qui permet aux développeurs d’ajouter leurs propres polices au processus de rendu. Si vous avez besoin d’utiliser des polices personnalisées au lieu des polices installées sur le système d’exploitation, vous pouvez définir le chemin d’accès à votre dossier personnalisé, comme suit :

// Set font folder for HTML to PDF conversion using Java

// Prepare HTML code and save it to a file
String code = "<h1>FontsSettings property</h1>\r\n" +
        "<p>The FontsSettings property is used for configuration of fonts handling.</p>\r\n";

try (java.io.FileWriter fileWriter = new java.io.FileWriter("user-agent-fontsetting.html")) {
    fileWriter.write(code);
}

// Initialize an instance of the Configuration class
Configuration configuration = new Configuration();

// Get the IUserAgentService
IUserAgentService userAgent = configuration.getService(IUserAgentService.class);

// Set a custom font folder path
userAgent.getFontsSettings().setFontsLookupFolder("fonts");

// Initialize an HTML document with specified configuration
HTMLDocument document = new HTMLDocument("user-agent-fontsetting.html", configuration);

// Convert HTML to PDF
Converter.convertHTML(document, new PdfSaveOptions(), "user-agent-fontsetting_out.pdf");

Pour définir le dossier des polices avec Aspose.HTML for Java, nous utilisons la méthode setFontsLookupFolder() de la classe FontsSettings. Cette méthode vous permet de spécifier le dossier dans lequel se trouvent les polices personnalisées. En définissant le dossier des polices, Aspose.HTML recherchera les polices dans le dossier spécifié lors du rendu du document HTML.

La figure illustre le résultat de l’application des fichiers FontsSettings et UserStyleSheet (b) au fichier source “user-agent-fontsetting.html” (a).

Service d’exécution – Runtime Service

Le service d’exécution vous permet de contrôler la durée de vie des processus internes. Par exemple, en utilisant IRuntimeService, vous pouvez spécifier des délais d’attente pour les JavaScripts. Il est important de disposer d’un tel délai au cas où un script contiendrait une boucle sans fin. L’extrait de code suivant montre comment utiliser le Runtime Service pour limiter le temps d’exécution de JavaScript et convertir un document HTML au format image :

1. Dans l’exemple, nous créons un document HTML à partir de zéro. Le code HTML préparé comprend une boucle infinie dans un élément <script>. Nous utilisons la fonction FileWriter() pour écrire le code HTML dans un fichier.
2. Créer une instance de la classe Configuration.
3. Appelez la méthode getService() pour obtenir une instance du Runtime Service.
4. Utilisez la méthode setJavaScriptTimeout() du Runtime Service pour spécifier le temps d’exécution maximum autorisé du code JavaScript. L’exemple est fixé à 5 secondes.
5. Créez un objet HTMLDocument à l’aide du constructeur HTMLDocument(address, configuration). Il prend le chemin vers le fichier HTML précédemment créé et l’objet de configuration.
6. Convertir HTML en PNG en utilisant la méthode convertHTML(document, options, outputPath).

Dans l’exemple, si le délai de 5 secondes est dépassé pendant l’exécution de JavaScript, Aspose.HTML for Java interrompt l’exécution du code JavaScript et poursuit le reste du processus de conversion de HTML en PNG.

// Limit JavaScript execution time when converting HTML to image using Java

// Prepare HTML code and save it to a file
String code = "<h1>Runtime Service</h1>\r\n" +
        "<script> while(true) {} </script>\r\n" +
        "<p>The Runtime Service optimizes your system by helping it start apps and programs faster.</p>\r\n";

try (java.io.FileWriter fileWriter = new java.io.FileWriter("runtime-service.html")) {
    fileWriter.write(code);
}

// Create an instance of the Configuration class
Configuration configuration = new Configuration();

// Limit JS execution time to 5 seconds
IRuntimeService runtimeService = configuration.getService(IRuntimeService.class);
runtimeService.setJavaScriptTimeout(TimeSpan.fromSeconds(5));

// Initialize an HTML document with specified configuration
HTMLDocument document = new HTMLDocument("runtime-service.html", configuration);

// Convert HTML to PNG
Converter.convertHTML(document, new ImageSaveOptions(), "runtime-service_out.png");

Service de réseau – Network Service

INetworkService vous permet de contrôler tout le trafic entrant/sortant et de mettre en œuvre vos propres gestionnaires de messages. Il peut être utilisé à différentes fins : création d’un mécanisme de mise en cache personnalisé, suivi/enregistrement des messages de demande, etc.

Gestionnaires de messages

En utilisant la classe MessageHandler et en surchargeant la méthode invoke(), vous pouvez définir une logique personnalisée qui sera exécutée pendant les opérations réseau. L’exemple suivant montre comment utiliser les gestionnaires de messages pour enregistrer des informations sur les ressources inaccessibles. Dans cet exemple, la logique vérifie le code d’état de la réponse et gère le cas où le fichier n’est pas trouvé :

// Log failed HTTP requests with a custom MessageHandler

// Message handler logs all failed requests to the console
MessageHandler handler = new MessageHandler() {
    @Override
    public void invoke(INetworkOperationContext context) {
        if (context.getResponse().getStatusCode() != HttpURLConnection.HTTP_OK) {
            System.out.println(String.format("File '%s' Not Found", context.getRequest().getRequestUri().toString()));
        }

        // Invoke the next message handler in the chain
        next(context);
    }
};

Tout d’abord, vous devez créer un gestionnaire de messages personnalisé et l’utiliser comme suit :

// Handle missing image requests with a custom MessageHandler in Aspose.HTML for Java

// Prepare HTML code with missing image file
String code = "<img src='missing.jpg'>";

try (java.io.FileWriter fileWriter = new java.io.FileWriter("document.html")) {
    fileWriter.write(code);
}

// Create an instance of the Configuration class
Configuration configuration = new Configuration();

// Add ErrorMessageHandler to the chain of existing message handlers
INetworkService network = configuration.getService(INetworkService.class);
LogMessageHandler logHandler = new LogMessageHandler();
network.getMessageHandlers().addItem(logHandler);

// Initialize an HTML document with specified configuration
// During the document loading, the application will try to load the image and we will see the result of this operation in the console
HTMLDocument document = new HTMLDocument("document.html", configuration);

// Convert HTML to PNG
Converter.convertHTML(document, new ImageSaveOptions(), "output.png");

Conclusion

La fonction Configuration de l’environnement d’Aspose.HTML for Java permet aux développeurs d’affiner le comportement de leurs applications pour répondre à des exigences spécifiques. En utilisant la classe Configuration et ses services associés, vous pouvez gérer efficacement des aspects critiques tels que la sécurité, la personnalisation, l’encodage des caractères, les paramètres de police, la durée d’exécution et les opérations réseau.

• Sandbox améliore la sécurité en limitant l’exécution de scripts potentiellement dangereux.
• User Agent Service permet de personnaliser les styles, les jeux de caractères et les polices, offrant ainsi une expérience de rendu de document sur mesure.
• Runtime Service permet de contrôler le temps d’exécution de JavaScript afin d’éviter les scripts non réactifs ou malveillants.
• le Service réseau facilite le traitement personnalisé des demandes de réseau en fournissant des fonctions robustes de journalisation, de mise en cache et de contrôle du trafic.

Vous pouvez télécharger les exemples complets et les fichiers de données à partir de GitHub.