1. Diese Seite verwendet Cookies. Wenn du dich weiterhin auf dieser Seite aufhältst, akzeptierst du unseren Einsatz von Cookies. Weitere Informationen

Beispiel zur Einbindung des Scala-Interpreters in kompilierte Scala-Anwendungen

Dieses Thema im Forum "Java" wurde erstellt von Konstantin Denerz, 7. August 2008.

  1. Hallo,

    hier ist ein kleines Beispiel, dass zeigen soll, wie einfach man in seine kompilierte Scala-Anwendung, den Scala-Interpreter einbauen kann, um bestimmte Bereiche der Anwendung flexibel zu halten. Die Flexibilität erfolgt über in Scala geschriebene Skripte, die zur Laufzeit dynamisch kompiliert (interpretiert) werden. In dem Beispiel wird auch gezeigt, wie man bestimmte Kontexte an ein Skript bzw. an den Interpreter bindet. Damit lassen sich die Kontexte durch Skripte abrufen und manipulieren.

    Umgebung:
    Eclipse 3.4
    Scala Plugin Beta (nightly build)
    Scala 2.7.1 Final (scala-library.jar, scala-compiler.jar)

    Beispiel:

    In dem Beispiel erstelle ich einen Kontext(UserContext), der bestimmte Informationen oder Dienste enthält, auf die ich aus meinem Skript zugreifen will.

    Danach definiere ich meinen Prozess(UseCase), der einen Anwendungfall repräsentiert. In meinem Bespiel kann jeder Prozess eine Liste(subProcesses) mit Teilprozessen(auch vom Typ IProcess) beinhalten.
    Ein Teilprozess ist mein Skript(UserSpecificScript) was zusätzlich zu dem Code den ich für meinen Anwendungfall(UseCase) in der run Methode implementiere ausgeführt werden soll. Das Skript ist einfach gehalten und weist der Variable text, in dem Kontext, den Wert "Hello Bubu!" zu.

    In dem trait (interface) IScript ist eine Variable scriptsDirectory definiert. Diese verwende ich um die Pfade zu den Skripten dynamisch zusammen zu bauen. Der Pfad setzt sich aus scriptsDirectory + ClassName + .scala zusammen, wobei der ClassName der Name der Klasse ohne dem Package ist.

    Das Skript(UserSpecificScript.scala) selbst hab ich bei mir unter einem Pfad(/home/.../scripts abgelegt und einen Datei-Link(File>New>File>Advanced>Link to file in the file system) in Eclipse definiert. Somit kann das Skript aus Eclipse mit Syntax-Highlighter editieren werden.

    Hier ist die Ausgabe nach dem ich das Skript, während die Anwendung schläft(Thread.sleep), bearbeitet habe.
    Code (Text):
    1. performs script: userSpecificScript
    2. loaded script: context.text = "Hello Bubu!"
    3. context: de.kde.tutorials.scalaInterpreter.UserContext = [UserContext text=]
    4. [UserContext text=Hello Bubu!]
    5.  
    6. performs script: userSpecificScript
    7. loaded script: context.text = "Hello Bambi!"
    8. context: de.kde.tutorials.scalaInterpreter.UserContext = [UserContext text=Hello Bubu!]
    9. [UserContext text=Hello Bambi!]
    Eine mögliche Verbesserung von dem Bespiel wäre: das Cachen der Classfiles, die der Scala-Compiler beim Interpretieren in einem temporären Verzeichnis(/tmp/scalaint*****/) ablegt. Damit man ein Skript NUR neu interpretiert, sobald es sich ändert und nicht ständig den Interpreter bei größeren Skripten quälen muss.


    Skript:

    Code (Java):
    1. context.text = "Hello Bubu!"
    Geändertes Skript:

    Code (Java):
    1. context.text = "Hello Bambi!"
    Code:

    Code (Java):
    1. package de.kde.tutorials.scalaInterpreter
    2.  
    3. import scala.tools.nsc._
    4. import java.io._
    5.  
    6. /*
    7.  * [USER=136855]@author[/USER] konstantin.denerz
    8.  */
    9. object InterpreterExample {
    10.  
    11.   def main(args : Array[String]) : Unit = {
    12.  
    13.     // define user context
    14.     var context = new UserContext
    15.    
    16.     // define use case
    17.     var useCase = new UseCase
    18.    
    19.     // run the process
    20.     useCase.run(context)
    21.    
    22.     // show the changed context
    23.     println(context)
    24.    
    25.     // sleep during script manipulation
    26.     Thread sleep 5000
    27.     useCase.run(context)
    28.     println(context)
    29.    
    30.    
    31.   }
    32.  
    33. }
    34.  
    35. /*
    36.  * the context used to run a process
    37.  */
    38. trait IContext {}
    39.  
    40. /*
    41.  * User context
    42.  */
    43. class UserContext extends IContext{
    44.   var _text = ""
    45.   // getter
    46.   def text = {_text}
    47.   // setter
    48.   def text_=(theText: String) {
    49.     _text = theText
    50.   }
    51.  
    52.   override def toString() : String = { "[UserContext text=" + text + "]" }
    53.  
    54. }
    55.  
    56.  
    57. trait IProcess {
    58.   var subProcesses = Map[String, IProcess]()
    59.  
    60.   def run(context: IContext) {
    61.     // run all scripts for this use case
    62.     subProcesses.keys.foreach(key =>
    63.       {
    64.         println("performs script: " + key)
    65.         subProcesses(key).run(context)
    66.       }
    67.     )
    68.   }
    69.  
    70. }
    71.  
    72. /*
    73.  * Interface for all scripts
    74.  */
    75. trait IScript extends IProcess {
    76.   /*
    77.    * path to directory which contains the scala script files
    78.    */
    79.   val scriptsDirectory = "/home/kde/private/projects/example/scripts"
    80.   // settings for the scala interpreter & compiler
    81.   val settings = new Settings(null)
    82.   var interpreter : Interpreter = _
    83.  
    84.   /*
    85.    * create a new instance of scala interpreter
    86.    */
    87.   def createInterpreter() {
    88.     settings.classpath.value = List(settings.classpath.value,"")
    89.       .mkString("",java.io.File.separator,"")
    90.     interpreter = new Interpreter(settings)
    91.   }
    92.  
    93.   /*
    94.    * read the script from file
    95.    */
    96.   def getScript() : String = {
    97.     var result = ""
    98.     // get the class name for instance :  Bubu
    99.     var className = this.getClass.getSimpleName
    100.     // read scala file
    101.     var file = new File(List(scriptsDirectory, className)
    102.                           .mkString("", "/", ".scala"))
    103.     var reader = new BufferedReader(new FileReader(file))
    104.     try{
    105.       var line = ""
    106.       do{
    107.         line = reader.readLine
    108.         if(null != line){
    109.           result+=line
    110.         }
    111.       }while(line != null)
    112.     }catch{
    113.       case e : Throwable => e.printStackTrace
    114.       case _=>
    115.     }
    116.    
    117.     println("loaded script: " + result)
    118.     result
    119.   }
    120.  
    121.   override def run(context: IContext) {
    122.     var script = getScript
    123.     // make the context reachable for the script
    124.     interpreter.bind("context", context.getClass.getName, context)
    125.     // interpret the script
    126.     interpreter.interpret(script)
    127.    
    128.     super.run(context)
    129.   }
    130.  
    131. }
    132.  
    133. class UseCase extends IProcess {
    134.  
    135.   subProcesses = Map("userSpecificScript" -> new UserSpecificScript)
    136.  
    137.   override def run(context: IContext) {
    138.     // ...
    139.    
    140.     super.run(context)
    141.   }
    142.  
    143. }
    144.  
    145.  
    146.  
    147. class UserSpecificScript extends IScript{
    148.   createInterpreter()
    149.  
    150.   override def run(context: IContext) {
    151.     // ...
    152.    
    153.     // run the script
    154.     super.run(context)
    155.   }
    156.  
    157. }
    Gruß Konstantin
     
    Zuletzt von einem Moderator bearbeitet: 23. Mai 2014
  2. Thomas Darimont

    Thomas Darimont Premium-User

    Hallo,

    schickes Beispiel ;) Im Prinzip ist hier der springende Punkt das man beliebige Objekte an den Scala Interpreter binden und somit eine "Kommunikation" zwischen Script Umgebung und "äußerer" Laufzeit möglich ist.

    Man siehe auch:
    http://www.jugsaar.de/?p=131

    Hier noch ein Beispiel wie man von Java aus ein Objekt an ein Scala Script übergeben kann:

    Hier unser scala Script in einem separeten Scala Projekt:
    Code (Text):
    1. package de.tutorials.scala2
    2.  
    3. object Test {
    4.   def main(args:Array[String])={
    5.     println(args.toList)
    6.     args(0)="Scala"
    7.   }
    8. }
    Hier rufen wir das Scala Script aus einer java Anwendung aus auf:
    (Hier rufe ich eine Methode einer schon kompilierten Scala Klasse auf. Die entsprechenden .class Files müssen natürlich auch im Classpath liegen, bei mir habe ich dazu den Class Folder (bin) des entsprechenden Scalaprojektes im Java Buildpath des Javaprojektes eingebunden)
    Code (Java):
    1. /**
    2.  *
    3.  */
    4. package de.tutorials;
    5.  
    6. import scala.tools.nsc.Interpreter;
    7. import scala.tools.nsc.Settings;
    8.  
    9. /**
    10.  * @author Thomas.Darimont
    11.  *
    12.  */
    13. public class ScalaInterpreterExample {
    14.  
    15.     /**
    16.      * @param args
    17.      */
    18.     public static void main(String[] args) throws Exception {
    19.         Settings settings = new Settings();
    20.         System.out.println(settings.classpath());
    21.  
    22.  
    23.         Interpreter interpreter = new Interpreter(settings);
    24.  
    25.         String[] context = { "FOO" };
    26.         interpreter.bind("context", "Array[String]", context);
    27.         interpreter
    28.                 .interpret("de.tutorials.scala2.Test.main(context)");
    29.        
    30.         context[0] = "BAR";
    31.        
    32.         interpreter
    33.                 .interpret("de.tutorials.scala2.Test.main(context)");
    34.         interpreter
    35.                 .interpret("binder0.getClass.getProtectionDomain.getCodeSource.getLocation");
    36.        
    37.         System.out.println(context[0]);
    38.     }
    39. }
    Ausgabe:
    Code (Text):
    1. StringSetting(-classpath,path,Specify where to find user class files,D:\eclipse\workspaces\workspace-3.4\de.tutorials.training\bin;D:\stuff\jtds\jtds-1.2.2.jar;D:\stuff\neo4j\neo-1.0-b6\neo-1.0-b6.jar;D:\stuff\neo4j\neo-1.0-b6\jta-spec1_0_1.jar;D:\eclipse\3.4\eclipse\plugins\org.eclipse.team.svn_0.7.1.I20080612-1500.jar;D:\eclipse\3.4\eclipse\plugins\org.eclipse.team.svn.core_0.7.1.I20080612-1500.jar;D:\eclipse\3.3M7\eclipse\plugins\org.polarion.team.client.javasvn.standard.core_1.1.2\lib\svnkit.jar;D:\eclipse\3.3M7\eclipse\plugins\org.polarion.team.client.javasvn.standard.core_1.1.2\lib\svnkit-javahl.jar;D:\stuff\log4j\1.2\apache-log4j-1.2.15\log4j-1.2.15.jar;D:\stuff\scala\2.7.1\scala-2.7.1.final\lib\scala-library.jar;D:\stuff\scala\2.7.1\scala-2.7.1.final\lib\sbaz.jar;D:\stuff\scala\2.7.1\scala-2.7.1.final\lib\sbaz-tests.jar;D:\stuff\scala\2.7.1\scala-2.7.1.final\lib\scala-compiler.jar;D:\stuff\scala\2.7.1\scala-2.7.1.final\lib\scala-dbc.jar;D:\stuff\scala\2.7.1\scala-2.7.1.final\lib\scala-decoder.jar;D:\eclipse\workspaces\workspace-3.4\de.tutorials.scala2\bin)
    2. context: Array[String] = Array(FOO)
    3. List(FOO)
    4. List(BAR)
    5. res2: java.net.URL = file:/C:/DOKUME~1/THOMAS~1.DAR/LOKALE~1/Temp/scalaint47770/
    6. Scala
    Gruß Tom
     
  3. Hallo,

    hier eine kleine Erweiterung des Beispiels. Dabei werden zwar nicht die Classfiles gecachet, jedoch wird verhindert, dass ein Skript jedes mal neu interpretiert/kompiliert wird, bis man es wünscht.

    hier das geänderte Trait:
    Code (Java):
    1. /*
    2.  * Interface for all scripts
    3.  */
    4. trait IScript extends IProcess {
    5.  
    6.   // ....
    7.  
    8.   /*
    9.    * read the script
    10.    */
    11.   def getScript() : String = {
    12.     var result = ""
    13.     // get the class name for instance :  Bubu
    14.     var className = this.getClass.getSimpleName
    15.     // read scala file
    16.     var file = new File(List(scriptsDirectory, className)
    17.                           .mkString("", "/", ".scala"))
    18.    
    19.     if(isDirty){
    20.       result = getScriptRunner + System.getProperty("line.separator") + getScriptFrom(file)
    21.     }else{
    22.     // run the runner only
    23.       result = getScriptRunner()
    24.     }
    25.    
    26.     println("loaded script: " + result)
    27.     result
    28.   }
    29.  
    30.  
    31.   override def run(context: IContext) {
    32.     var script = getScript
    33.     // make the context reachable for the script
    34.     interpreter.bind("context", context.getClass.getName, context)
    35.     // interpret the script
    36.     interpreter.interpret(script)
    37.    
    38.     super.run(context)
    39.    
    40.     isDirty = false
    41.    
    42.   }
    43.  
    44.   var isDirty = true
    45.  
    46.   def getScriptRunner() = {
    47.     "Runner.run"
    48.   }
    49.  
    50.   def getScriptFrom(file: File) = {
    51.     var result = ""
    52.     var reader = new BufferedReader(new FileReader(file))
    53.     try{
    54.      
    55.       var line = ""
    56.       do{
    57.         line = reader.readLine
    58.         if(null != line){
    59.           result += line + System.getProperty("line.separator")
    60.         }
    61.       }while(line != null)
    62.        
    63.     }catch{
    64.       case e : Throwable => e.printStackTrace
    65.       case _=>
    66.     }
    67.     result
    68.   }
    69.  
    70. }

    Und hier das neue Skript. Dabei ist eine Klasse(MyScript) zu sehen, die eine Methode zum Manipulieren des Kontexts hat. Wenn der Interpreter dieses Skript einmal interpretiert (kompiliert), dann werden die Classfiles dafür generiert. Solange das Skript sich nicht ändert, kann man den Runner zum Ausführen des Skript verwenden. In run Methode des IScript traits wird dann statt dem ganzen Skript, einfach nur der Aufruf Runner.run interpretiert. Somit ruft immer das gleiche Skript, ohne es neu zu kompilieren, auf.

    UserSpecificScript.scala:
    Code (Java):
    1. object Runner{
    2.   def run = {
    3.     var script = new MyScript
    4.     script.changeContext(context)
    5.   }
    6. }
    7.  
    8. import de.kde.tutorials.scalaInterpreter._
    9.  
    10. class MyScript{
    11.  
    12.   def changeContext(theContext : IContext) = {
    13.      theContext.asInstanceOf[UserContext].text = "Hello Bambi!"
    14.   }
    15.  
    16. }
    Hier die Ausgabe von dem Ganzen, woran man erkennt, dass beim zweiten Aufruf nur der Context nochmal an den Interpreter gebunden und der Runner ausgeführt wird, ohne das module Runner und MySkript neu definiert (kompiliert) werden.

    Code (Text):
    1. performs script: userSpecificScript
    2. loaded script: Runner.run
    3. object Runner{
    4.   def run = {
    5.     var script = new MyScript
    6.     script.changeContext(context)
    7.   }
    8. }
    9.  
    10. import de.kde.tutorials.scalaInterpreter._
    11.  
    12. class MyScript{
    13.  
    14.   def changeContext(theContext : IContext) = {
    15.      theContext.asInstanceOf[UserContext].text = "Hello Bambi!"
    16.   }
    17.  
    18. }
    19.  
    20. context: de.kde.tutorials.scalaInterpreter.UserContext = [UserContext text=]
    21. defined module Runner
    22. import de.kde.tutorials.scalaInterpreter._
    23. defined class MyScript
    24. [UserContext text=Hello Bambi!]
    25.  
    26.  
    27.  
    28.  
    29.  
    30. performs script: userSpecificScript
    31. loaded script: Runner.run
    32. context: de.kde.tutorials.scalaInterpreter.UserContext = [UserContext text=Hello Bambi!]
    33. [UserContext text=Hello Bambi!]

    Gruß Konstantin
     
    Zuletzt von einem Moderator bearbeitet: 23. Mai 2014

Diese Seite empfehlen