Home > Articles

Scripting, Compiling, and Annotation Processing

  • Print
  • + Share This

Cay Horstmann discusses three techniques for processing code. The scripting and compiler APIs allow your program to call code in scripting languages such as JavaScript or Groovy, and to compile Java code. Annotations allow you to add arbitrary information (sometimes called metadata) to a Java program. He shows how annotation processors can harvest these annotations at the source or class file level, and how annotations can be used to influence the behavior of classes at runtime. Annotations are only useful with tools, and this discussion will help you select useful annotation processing tools for your needs.

This chapter is from the book

This chapter introduces three techniques for processing code. The scripting API lets you invoke code in a scripting language such as JavaScript or Groovy. You can use the compiler API when you want to compile Java code inside your application. Annotation processors operate on Java source or class files that contain annotations. As you will see, there are many applications for annotation processing, ranging from simple diagnostics to “bytecode engineering”—the insertion of bytecodes into class files or even running programs.

8.1 Scripting for the Java Platform

A scripting language is a language that avoids the usual edit/compile/link/run cycle by interpreting the program text at runtime. Scripting languages have a number of advantages:

  • Rapid turnaround, encouraging experimentation

  • Changing the behavior of a running program

  • Enabling customization by program users

On the other hand, most scripting languages lack features that are beneficial for programming complex applications, such as strong typing, encapsulation, and modularity.

It is therefore tempting to combine the advantages of scripting and traditional languages. The scripting API lets you do just that for the Java platform. It enables you to invoke scripts written in JavaScript, Groovy, Ruby, and even exotic languages such as Scheme and Haskell, from a Java program. For example, the Renjin project (www.renjin.org) provides a Java implementation of the R programming language, which is commonly used for statistical programming, together with an “engine” of the scripting API.

In the following sections, we’ll show you how to select an engine for a particular language, how to execute scripts, and how to make use of advanced features that some scripting engines offer.

8.1.1 Getting a Scripting Engine

A scripting engine is a library that can execute scripts in a particular language. When the virtual machine starts, it discovers the available scripting engines. To enumerate them, construct a ScriptEngineManager and invoke the getEngineFactories method. You can ask each engine factory for the supported engine names, MIME types, and file extensions. Table 8.1 shows typical values.

Table 8.1 Properties of Scripting Engine Factories

Engine

Names

MIME types

Extensions

Nashorn
(included
with Java SE)

nashorn, Nashorn, js, JS,
JavaScript, javascript,
ECMAScript, ecmascript

application/javascript,
application/ecmascript,
text/javascript,
text/ecmascript

js

Groovy

groovy

None

groovy

Renjin

Renjin

text/x-R

R, r, S, s

SISC Scheme

sisc

None

scheme, sisc

Usually, you know which engine you need, and you can simply request it by name, MIME type, or extension. For example:

ScriptEngine engine = manager.getEngineByName("nashorn");

Java SE 8 includes a version of Nashorn, a JavaScript interpreter developed by Oracle. You can add more languages by providing the necessary JAR files on the class path.

8.1.2 Script Evaluation and Bindings

Once you have an engine, you can call a script simply by invoking

Object result = engine.eval(scriptString);

If the script is stored in a file, open a Reader and call

Object result = engine.eval(reader);

You can invoke multiple scripts on the same engine. If one script defines variables, functions, or classes, most scripting engines retain the definitions for later use. For example,

engine.eval("n = 1728");
Object result = engine.eval("n + 1");

will return 1729.

You will often want to add variable bindings to the engine. A binding consists of a name and an associated Java object. For example, consider these statements:

engine.put("k", 1728);
Object result = engine.eval("k + 1");

The script code reads the definition of k from the bindings in the “engine scope.” This is particularly important because most scripting languages can access Java objects, often with a syntax that is simpler than the Java syntax. For example,

engine.put("b", new JButton());
engine.eval("b.text = 'Ok'");

Conversely, you can retrieve variables that were bound by scripting statements:

engine.eval("n = 1728");
Object result = engine.get("n");

In addition to the engine scope, there is also a global scope. Any bindings that you add to the ScriptEngineManager are visible to all engines.

Instead of adding bindings to the engine or global scope, you can collect them in an object of type Bindings and pass it to the eval method:

Bindings scope = engine.createBindings();
scope.put("b", new JButton());
engine.eval(scriptString, scope);

This is useful if a set of bindings should not persist for future calls to the eval method.

8.1.3 Redirecting Input and Output

You can redirect the standard input and output of a script by calling the setReader and setWriter methods of the script context. For example,

StringWriter writer = new StringWriter();
engine.getContext().setWriter(new PrintWriter(writer, true));

Any output written with the JavaScript print or println functions is sent to writer.

The setReader and setWriter methods only affect the scripting engine’s standard input and output sources. For example, if you execute the JavaScript code

println("Hello");
java.lang.System.out.println("World");

only the first output is redirected.

The Nashorn engine does not have the notion of a standard input source. Calling setReader has no effect.

8.1.4 Calling Scripting Functions and Methods

With many script engines, you can invoke a function in the scripting language without having to evaluate the actual script code. This is useful if you allow users to implement a service in a scripting language of their choice.

The script engines that offer this functionality implement the Invocable interface. In particular, the Nashorn engine implements Invocable.

To call a function, call the invokeFunction method with the function name, followed by the function parameters:

// Define greet function in JavaScript
engine.eval("function greet(how, whom) { return how + ', ' + whom + '!' }");

// Call the function with arguments "Hello", "World"
result = ((Invocable) engine).invokeFunction("greet", "Hello", "World");

If the scripting language is object-oriented, call invokeMethod:

// Define Greeter class in JavaScript
engine.eval("function Greeter(how) { this.how = how }");
engine.eval("Greeter.prototype.welcome = "
   + " function(whom) { return this.how + ', ' + whom + '!' }");

// Construct an instance
Object yo = engine.eval("new Greeter('Yo')");

// Call the welcome method on the instance
result = ((Invocable) engine).invokeMethod(yo, "welcome", "World");

You can go a step further and ask the scripting engine to implement a Java interface. Then you can call scripting functions and methods with the Java method call syntax.

The details depend on the scripting engine, but typically you need to supply a function for each method of the interface. For example, consider a Java interface

public interface Greeter
{
   String welcome(String whom);
}

If you define a global function with the same name in Nashorn, you can call it through this interface.

// Define welcome function in JavaScript
engine.eval("function welcome(whom) { return 'Hello, ' + whom + '!' }");

// Get a Java object and call a Java method
Greeter g = ((Invocable) engine).getInterface(Greeter.class);
result = g.welcome("World");

In an object-oriented scripting language, you can access a script class through a matching Java interface. For example, here is how to call an object of the JavaScript SimpleGreeter class with Java syntax:

Greeter g = ((Invocable) engine).getInterface(yo, Greeter.class);
result = g.welcome("World");

In summary, the Invocable interface is useful if you want to call scripting code from Java without worrying about the scripting language syntax.

8.1.5 Compiling a Script

Some scripting engines can compile scripting code into an intermediate form for efficient execution. Those engines implement the Compilable interface. The following example shows how to compile and evaluate code contained in a script file:

Reader reader = new FileReader("myscript.js");
CompiledScript script = null;
if (engine implements Compilable)
   script = ((Compilable) engine).compile(reader);

Once the script is compiled, you can execute it. The following code executes the compiled script if compilation was successful, or the original script if the engine didn’t support compilation:

if (script != null)
   script.eval();
else
   engine.eval(reader);

Of course, it only makes sense to compile a script if you need to execute it repeatedly.

8.1.6 An Example: Scripting GUI Events

To illustrate the scripting API, we will write a sample program that allows users to specify event handlers in a scripting language of their choice.

Have a look at the program in Listing 8.1 that adds scripting to an arbitrary frame class. By default it reads the ButtonFrame class in Listing 8.2, which is similar to the event handling demo in Volume I, with two differences:

  • Each component has its name property set.

  • There are no event handlers.

The event handlers are defined in a property file. Each property definition has the form

componentName.eventName = scriptCode

For example, if you choose to use JavaScript, supply the event handlers in a file js.properties, like this:

yellowButton.action=panel.background = java.awt.Color.YELLOW
blueButton.action=panel.background = java.awt.Color.BLUE
redButton.action=panel.background = java.awt.Color.RED

The companion code also has files for Groovy, R, and SISC Scheme.

The program starts by loading an engine for the language specified on the command line. If no language is specified, we use JavaScript.

We then process a script init.language if it is present. This is useful for the R and Scheme languages, which need some initializations that we did not want to include in every event handler script.

Next, we recursively traverse all child components and add the bindings (name, object) into a map of components. Then we add the bindings to the engine.

Next, we read the file language.properties. For each property, we synthesize an event handler proxy that causes the script code to be executed. The details are a bit technical. You might want to read the section on proxies in Volume I, Chapter 6, if you want to follow the implementation in detail. The essential part, however, is that each event handler calls

engine.eval(scriptCode);

Let us look at the yellowButton in more detail. When the line

yellowButton.action=panel.background = java.awt.Color.YELLOW

is processed, we find the JButton component with the name "yellowButton". We then attach an ActionListener with an actionPerformed method that executes the script

panel.background = java.awt.Color.YELLOW

if the scripting is done with Nashorn.

The engine contains a binding that binds the name "panel" to the JPanel object. When the event occurs, the setBackground method of the panel is executed, and the color changes.

You can run this program with the JavaScript event handlers simply by executing

java ScriptTest

For the Groovy handlers, use

java -classpath .:groovy/lib/\* ScriptTest groovy

Here, groovy is the directory into which you installed Groovy.

For the Renjin implementation of R, include the JAR files for Renjin Studio and the Renjin script engine on the classpath. Both are available at www.renjin.org/ downloads.html.

To try out Scheme, download SISC Scheme from http://sisc-scheme.org and run

java -classpath .:sisc/*:jsr223-engines/scheme/build/scheme-engine.jar ScriptTest scheme

where sisc is the installation directory for SISC Scheme and jsr223-engines is the directory that contains the engine adapters from http://java.net/projects/scripting.

This application demonstrates how to use scripting for Java GUI programming. One could go a step further and describe the GUI with an XML file, as you have seen in Chapter 3. Then our program would become an interpreter for GUIs that have visual presentation defined by XML and behavior defined by a scripting language. Note the similarity to a dynamic HTML page or a dynamic server-side scripting environment.

Listing 8.1 script/ScriptTest.java

 1   package script;
 2
 3   import java.awt.*;
 4   import java.beans.*;
 5   import java.io.*;
 6   import java.lang.reflect.*;
 7   import java.util.*;
 8   import javax.script.*;
 9   import javax.swing.*;
10
11   /**
12    * @version 1.02 2016-05-10
13    * @author Cay Horstmann
14    */
15   public class ScriptTest
16   {
17      public static void main(String[] args)
18      {
19         EventQueue.invokeLater(() ->
20            {
21               try
22               {
23                  ScriptEngineManager manager = new ScriptEngineManager();
24                  String language;
25                  if (args.length == 0)
26                  {
27                     System.out.println("Available factories: ");
28                     for (ScriptEngineFactory factory : manager.getEngineFactories())
29                        System.out.println(factory.getEngineName());
30
31                     language = "nashorn";
32                  }
33                  else language = args[0];
34
35                  final ScriptEngine engine = manager.getEngineByName(language);
36                  if (engine == null)
37                  {
38                     System.err.println("No engine for " + language);
39                     System.exit(1);
40                  }
41
42                  final String frameClassName = args.length < 2 ? "buttons1.ButtonFrame" : args[1];
43                  JFrame frame = (JFrame) Class.forName(frameClassName).newInstance();
44                  InputStream in = frame.getClass().getResourceAsStream("init." + language);
45                  if (in != null) engine.eval(new InputStreamReader(in));
46                  Map<String, Component> components = new HashMap<>();
47                  getComponentBindings(frame, components);
48                  components.forEach((name, c) -> engine.put(name, c));
49
50                  final Properties events = new Properties();
51                  in = frame.getClass().getResourceAsStream(language + ".properties");
52                  events.load(in);
53
54                  for (final Object e : events.keySet())
55                  {
56                     String[] s = ((String) e).split("\\.");
57                     addListener(s[0], s[1], (String) events.get(e), engine, components);
58                  }
59                  frame.setTitle("ScriptTest");
60                  frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
61                  frame.setVisible(true);
62               }
63               catch (ReflectiveOperationException | IOException
64                     | ScriptException | IntrospectionException ex)
65               {
66                  ex.printStackTrace();
67               }
68            });
69      }
70
71      /**
72       * Gathers all named components in a container.
73       * @param c the component
74       * @param namedComponents a map into which to enter the component names and components
75       */
76      private static void getComponentBindings(Component c, Map<String, Component> namedComponents)
77      {
78         String name = c.getName();
79         if (name != null) { namedComponents.put(name, c); }
80         if (c instanceof Container)
81         {
82            for (Component child : ((Container) c).getComponents())
83               getComponentBindings(child, namedComponents);
84         }
85      }
86
87      /**
88       * Adds a listener to an object whose listener method executes a script.
89       * @param beanName the name of the bean to which the listener should be added
90       * @param eventName the name of the listener type, such as "action" or "change"
91       * @param scriptCode the script code to be executed
92       * @param engine the engine that executes the code
93       * @param bindings the bindings for the execution
94       * @throws IntrospectionException
95       */
96      private static void addListener(String beanName, String eventName, final String scriptCode,
97            final ScriptEngine engine, Map<String, Component> components)
98         throws ReflectiveOperationException, IntrospectionException
99      {
100       Object bean = components.get(beanName);
101       EventSetDescriptor descriptor = getEventSetDescriptor(bean, eventName);
102       if (descriptor == null) return;
103       descriptor.getAddListenerMethod().invoke(bean,
104          Proxy.newProxyInstance(null, new Class[] { descriptor.getListenerType() },
105             (proxy, method, args) ->
106                {
107                   engine.eval(scriptCode);
108                   return null;
109                }
110             ));
111    }
112
113    private static EventSetDescriptor getEventSetDescriptor(Object bean, String eventName)
114       throws IntrospectionException
115    {
116       for (EventSetDescriptor descriptor : Introspector.getBeanInfo(bean.getClass())
117             .getEventSetDescriptors())
118          if (descriptor.getName().equals(eventName)) return descriptor;
119       return null;
120    }
121  }

Listing 8.2 buttons1/ButtonFrame.java

 1   package buttons1;
 2
 3   import javax.swing.*;
 4
 5   /**
 6   * A frame with a button panel.
 7   * @version 1.00 2007-11-02
 8   * @author Cay Horstmann
 9   */
10  public class ButtonFrame extends JFrame
11  {
12     private static final int DEFAULT_WIDTH = 300;
13     private static final int DEFAULT_HEIGHT = 200;
14
15     private JPanel panel;
16     private JButton yellowButton;
17     private JButton blueButton;
18     private JButton redButton;
19
20     public ButtonFrame()
21     {
22        setSize(DEFAULT_WIDTH, DEFAULT_HEIGHT);
23
24        panel = new JPanel();
25        panel.setName("panel");
26        add(panel);
27
28        yellowButton = new JButton("Yellow");
29        yellowButton.setName("yellowButton");
30        blueButton = new JButton("Blue");
31        blueButton.setName("blueButton");
32        redButton = new JButton("Red");
33        redButton.setName("redButton");
34
35        panel.add(yellowButton);
36        panel.add(blueButton);
37        panel.add(redButton);
38     }
39   }
  • + Share This
  • 🔖 Save To Your Account