(此文大部分翻译整理自Eclipse Modeling Framework: A Developer's Guild的13.2章)
在EMF Persistence API中主要涉及到4个接口Resource, ResourceSet, Resource.Factory以及URIconverter。虽然EMF提供了这些接口的缺省的XML序列化的实现,但是也可以用这些API来实现其他的序列化方式,不论其是否是基于XML的,或者基于流的。
URI用来表示某一类型的数据,由三个部分组成:scheme, scheme-specific part以及可选的fragment。EMF提供了自己的URI的实现(而没有用JDK的URL):org.eclipse.emf.common.util.URI。
scheme部分表示了存取resource的协议,可以使标准的file,或者是jar。在eclipse中,使用platform来存取在workspace中的resource。例如:platform:/resource/project/po.xml。EMF也提供了EcoreUtil.getPlatformResourceMap(),来将一个platform的URI转换成标准的基于本地文件系统file协议的URI。
scheme-specific part的解释会根据具体的scheme不同而不同,但是在EMF中,使用了一种通用的层次格式,这种格式包括autority, device,以及一系列的segments。authority由//打头。其它均由/打头。
fragment表示一个resource内部的的一个部分。使用#来同其他部分分离。例如:file:/c:/dir1/dir2/myfile.xml#loc。EMF使用带有fragment的URI来对resource中的EObject进行引用。每一个EMF resource都有一个唯一的URI,而每一个resource中的对象,都有一个唯一的fragement来标志它。
URIConverter将一个输入的URI转换成一个resource的真实地URI。可以用来将一个namespace URI转换成一个物理文件的URI,或者重定向到另外的一个老的URI上。
Resource表示一个EObject的序列化容器,其实际地址由其URI所指定。Resource接口最重要的方法是save(), load(),getEObject()以及getURIFragment()方法。save()和load()方法在ResourceImpl中并没有具体的处理装载与保存的实现,具体的处理是由storage-specific的resource的子类完成的。
Resource的unload()方法在某些时候也会很有用。它会将Resource中的所有对象都转换为代理对象,使得后续的调用变成ondemand的调用,这能够让你得到最新的数据。如果底层的文件发生了改变的话。
Resource的getEObject()方法能够使用一个对象的fragment来存取一个EObject。例如:
Item item = (Item)resource.getEObject("//@orders.0/@items.2");
要得到一个对象的fragment也很容易,使用getURIFragment()方法即可:
String fragment = resource.getURIFragment(item);
Resource.Factory是用来创建Resource的。Resource.Factory是由一个注册库Registry来管理,定位的。一个Resource.Factory对应于一类URI,而不是某一特定的URI。例如,缺省的registry允许你为一类的URI scheme或者extension注册一个Resource.Factory。Resource.Factory可以通过一个定义在Resource.Factory内部的Descriptor来进行注册。Descriptor提供了创建Factory的方法。这里也是一个插件的扩展点,可以用来向系统中注册新的Descriptor。
Registry可以用过其静态的INSTANCE字段来访问其一个实例,缺省实现是ResourceFactoryRegistryImpl。它首先会根据URI的scheme来检查protocolToFactoryMap中的Factory,如果没有找到,则使用URI的文件的扩展名来检查extensionToFactoryMap中是否有,如果人染没有找到,则查找extensionToFactoryMap的DEFAULT_EXTENSION(也就是*)。如果仍然没有找到,则调用delegatedGetFactory(),允许你装载一个自己的Factory Registry。当找到一个Descriptor之后,调用其createFactory()来创建一个Factory。
下面的这个扩展点是定义在org.eclipse.emf.ecore.xmi插件中的:
<extension point = "org.eclipse.emf.ecore.extension_parser">
<parser type="*"
class="org.eclipse.emf.ecore.xmi.impl.XMIResourceFactoryImpl"/>
</extension>
可以看到,XMIResourceFactoryImpl被作为缺省的ResourceFactory注册了,因此在没有其它的Factory被注册的时候,将缺省使用XMIResourceFactoryImpl。你也同样可以创建新的Resource实现,以及对应的Factory,并通过上面的扩展点来进行注册。
当EMF运行在非Eclipse环境下时,缺省的扩展点没有被注册,则需要手工的注册:
Resource.Factory.Registry.INSTANCE.
getExtensionToFactoryMap().put("*", new XMIResourceFactoryImpl());
Resource.Factory被ResourceSet所使用来创建Resource。
一个ResourceSet代表了一个Resource的集合。提供了createResource(),getResource(),以及getEObject()方法。createResource()创建一个新的,空的resource。getResource()方法也同样创建一个resource,但是会使用给定的URI来装载这个Resource。用户应该始终调用ResourceSet的这两个方法,而不是Resource的构造函数或者Resource.Factory的createResource()方法来创建一个Resource。这是因为ResourceSet会保证相同的URI所对应的Resource不会被装载多次,而导致内存中有相同的副本,并且,ResourceSet能够自动处理跨文档的引用,而Resource却不行。
EMF中资源的保存与读取,可以通过下面的两个简单的代码片断来例示:
装载:
ResourceSet resourceSet2 = new ResourceSetImpl();
URI fileURI2 = URI.createFileURI(filepath);
//Attention, The second parameter must be trur to get the resource for the first time.
Resource poResource2 = resourceSet2.getResource(fileURI2, true);
保存也很简单:
URI fileURI = URI.createFileURI(filepath);
Resource poResource = resourceSet.createResource(fileURI);
poResource.getContents().add(model);
try {
poResource.save(null);
} catch (IOException e) {
assertTrue("IOException: " + e.getMessage(), false);
}