Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
<description>SOFABoot Build</description>

<properties>
<revision>4.3.0</revision>
<revision>4.4.0-SNAPSHOT</revision>
<sofa.boot.version>${revision}</sofa.boot.version>
<spring.boot.version>3.2.6</spring.boot.version>
<!--project-->
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.alipay.sofa.boot.Initializer;

import com.alipay.sofa.boot.util.ModuleUtil;
import org.springframework.context.ApplicationContextInitializer;
import org.springframework.context.ConfigurableApplicationContext;

/**
* @author huazhongming
* @since 4.4.0
*/
public class DynamicModuleExportApplicationContextInitializer
implements
ApplicationContextInitializer<ConfigurableApplicationContext> {
@Override
public void initialize(ConfigurableApplicationContext applicationContext) {
ModuleUtil.exportAllJDKModulePackageToAll();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,246 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.alipay.sofa.boot.util;

import com.alipay.sofa.boot.log.SofaBootLoggerFactory;
import org.slf4j.Logger;

import java.lang.invoke.MethodHandle;
import java.lang.reflect.Field;
import java.util.Map;
import java.util.Optional;

/**
* @author huazhongming
* @since 4.4.0
*/
public class ModuleUtil {

private static final Logger LOGGER = SofaBootLoggerFactory.getLogger(ModuleUtil.class);

private static final MethodHandle implAddOpensToAllUnnamed;
private static final MethodHandle implAddOpens;
private static final MethodHandle implAddExportsToAllUnnamed;
private static final MethodHandle implAddExports;

static {
implAddOpensToAllUnnamed = createModuleMethodHandle("implAddOpensToAllUnnamed",
String.class);
implAddOpens = createModuleMethodHandle("implAddOpens", String.class);
implAddExportsToAllUnnamed = createModuleMethodHandle("implAddExportsToAllUnnamed",
String.class);
implAddExports = createModuleMethodHandle("implAddExports", String.class);
}

/**
* Export all JDK module packages to all.
*/
public static void exportAllJDKModulePackageToAll() {
try {
Map<String, Module> nameToModules = getNameToModule();
if (nameToModules != null) {
nameToModules.forEach((name, module) -> module.getPackages().forEach(pkgName -> {
if (isJDKModulePackage(pkgName)) {
addOpensToAll(module, pkgName);
addExportsToAll(module, pkgName);
}
}));
}
} catch (Throwable t) {
LOGGER.error("Failed to export all JDK module package to all", t);
}
}

private static boolean isJDKModulePackage(String modulePackageName) {
return modulePackageName.startsWith("java.") || modulePackageName.startsWith("jdk.");
}

/**
* Export all module packages to all.
*/
public static void exportAllModulePackageToAll() {
try {
Map<String, Module> nameToModules = getNameToModule();
if (nameToModules != null) {
nameToModules.forEach((name, module) -> module.getPackages().forEach(pkgName -> {
addOpensToAll(module, pkgName);
addExportsToAll(module, pkgName);
}));
}
} catch (Throwable t) {
LOGGER.error("Failed to export all module package to all", t);
}
}

/**
* Updates this module to open a package to all unnamed modules.
*
* @param moduleName
* @param packageName
*/
public static boolean addOpensToAllUnnamed(String moduleName, String packageName) {
return invokeModuleMethod(implAddOpensToAllUnnamed, moduleName, packageName);
}

/**
* Updates this module to open a package to all unnamed modules.
*
* @param module
* @param packageName
*/
public static boolean addOpensToAllUnnamed(Module module, String packageName) {
return invokeModuleMethod(implAddOpensToAllUnnamed, module, packageName);
}

/**
* Updates this module to export a package to all unnamed modules.
*
* @param moduleName
* @param packageName
*/
public static boolean addExportsToAllUnnamed(String moduleName, String packageName) {
return invokeModuleMethod(implAddExportsToAllUnnamed, moduleName, packageName);
}

/**
* Updates this module to export a package to all unnamed modules.
*
* @param module
* @param packageName
*/
public static boolean addExportsToAllUnnamed(Module module, String packageName) {
return invokeModuleMethod(implAddExportsToAllUnnamed, module, packageName);
}

/**
* Updates this module to open a package to another module.
*
* @param moduleName
* @param packageName
*/
public static boolean addOpensToAll(String moduleName, String packageName) {

return invokeModuleMethod(implAddOpens, moduleName, packageName);
}

/**
* Updates this module to open a package to another module.
*
* @param module
* @param packageName
*/
public static boolean addOpensToAll(Module module, String packageName) {

return invokeModuleMethod(implAddOpens, module, packageName);
}

/**
* Updates this module to export a package unconditionally.
* @param moduleName
* @param packageName
*/
public static boolean addExportsToAll(String moduleName, String packageName) {
return invokeModuleMethod(implAddExports, moduleName, packageName);
}

/**
* Updates this module to export a package unconditionally.
* @param module
* @param packageName
*/
public static boolean addExportsToAll(Module module, String packageName) {
return invokeModuleMethod(implAddExports, module, packageName);
}

/**
* invoke ModuleLayer method
*
* @param method
* @param moduleName
* @param packageName
* @return
*/
public static boolean invokeModuleMethod(MethodHandle method, String moduleName,
String packageName) {
Comment on lines +185 to +186
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add null checks for method handles to prevent NullPointerException

The method parameter may be null if the method handle creation fails. Invoking method.invoke(...) without checking for null can lead to a NullPointerException. Please add a null check before using the method handle.

Apply this diff to add null checks:

 public static boolean invokeModuleMethod(MethodHandle method, String moduleName,
                                          String packageName) {
+    if (method == null) {
+        LOGGER.error("Method handle is null for module: {}, package: {}", moduleName, packageName);
+        return false;
+    }
     Optional<Module> findModule = ModuleLayer.boot().findModule(moduleName);
     if (findModule.isPresent()) {
         try {
             return invokeModuleMethod(method, findModule.get(), packageName);
         } catch (Throwable t) {
             LOGGER.error("Failed to invoke ModuleLayer method: {}", method, t);
         }
     }
     return false;
 }

 public static boolean invokeModuleMethod(MethodHandle method, Module module, String packageName) {
+    if (method == null) {
+        LOGGER.error("Method handle is null for module: {}, package: {}", module.getName(), packageName);
+        return false;
+    }
     try {
         method.invoke(module, packageName);
         return true;
     } catch (Throwable t) {
         LOGGER.error("Failed to invoke Module method: {}", method, t);
     }
     return false;
 }

Also applies to: 201-202

Optional<Module> findModule = ModuleLayer.boot().findModule(moduleName);
if (findModule.isPresent()) {
try {
return invokeModuleMethod(method, findModule.get(), packageName);
} catch (Throwable t) {
LOGGER.error("Failed to invoke ModuleLayer method: {}", method, t);
}
}
return false;
}

public static boolean invokeModuleMethod(MethodHandle method, Module module, String packageName) {
try {
method.invoke(module, packageName);
return true;
} catch (Throwable t) {
LOGGER.error("Failed to invoke Module method: {}", method, t);
}
return false;
}

/**
* create MethodHandle from Module
*
* @param methodName
* @param parameterTypes
* @return MethodHandle
*/
private static MethodHandle createModuleMethodHandle(String methodName,
Class<?>... parameterTypes) {
try {
return UnsafeUtil.implLookup().unreflect(
Module.class.getDeclaredMethod(methodName, parameterTypes));
} catch (Throwable t) {
LOGGER.error("Failed to create Module method handle: {}", methodName, t);
}
return null;
}

/**
* Get ModuleLayer.bootLayer field value
*
* @param fieldName
* @return field value
*/
private static Object getModuleLayerFieldsValue(String fieldName) {
ModuleLayer moduleLayer = ModuleLayer.boot();
try {
Class<ModuleLayer> moduleLayerClass = ModuleLayer.class;
Field field = moduleLayerClass.getDeclaredField(fieldName);
return UnsafeUtil.implLookup().unreflectVarHandle(field).get(moduleLayer);
} catch (Throwable t) {
LOGGER.error("Failed to get ModuleLayer field value: {}", fieldName, t);
}
return null;
}

/**
* Get all modules from System.bootLayer
*
* @return modules
*/
@SuppressWarnings("unchecked")
public static Map<String, Module> getNameToModule() {
return (Map<String, Module>) getModuleLayerFieldsValue("nameToModule");
}
Comment on lines +251 to +252
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Handle potential ClassCastException in getNameToModule()

Casting the result of getModuleLayerFieldsValue("nameToModule") to (Map<String, Module>) may result in a ClassCastException if the field does not contain the expected type. Consider adding a type check before casting to ensure safety.

Apply this diff to safely handle the cast:

 public static Map<String, Module> getNameToModule() {
-    return (Map<String, Module>) getModuleLayerFieldsValue("nameToModule");
+    Object moduleMap = getModuleLayerFieldsValue("nameToModule");
+    if (moduleMap instanceof Map) {
+        return (Map<String, Module>) moduleMap;
+    } else {
+        LOGGER.error("Expected nameToModule to be a Map<String, Module>, but got: {}", moduleMap);
+        return null;
+    }
 }
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
return (Map<String, Module>) getModuleLayerFieldsValue("nameToModule");
}
public static Map<String, Module> getNameToModule() {
Object moduleMap = getModuleLayerFieldsValue("nameToModule");
if (moduleMap instanceof Map) {
return (Map<String, Module>) moduleMap;
} else {
LOGGER.error("Expected nameToModule to be a Map<String, Module>, but got: {}", moduleMap);
return null;
}
}


}
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.alipay.sofa.boot.util;

import sun.misc.Unsafe;

import java.lang.invoke.MethodHandles;
import java.lang.reflect.Field;

/**
* @author huazhongming
* @since 4.4.0
*/
public class UnsafeUtil {
private static Unsafe UNSAFE;
private static MethodHandles.Lookup IMPL_LOOKUP;

public static Unsafe unsafe() {
if (UNSAFE == null) {
Unsafe unsafe = null;
try {
Field theUnsafeField = Unsafe.class.getDeclaredField("theUnsafe");
theUnsafeField.setAccessible(true);
unsafe = (Unsafe) theUnsafeField.get(null);
} catch (Throwable ignored) {
}
UNSAFE = unsafe;
}

return UNSAFE;
}

public static MethodHandles.Lookup implLookup() {
if (IMPL_LOOKUP == null) {
Class<MethodHandles.Lookup> lookupClass = MethodHandles.Lookup.class;

try {
Field implLookupField = lookupClass.getDeclaredField("IMPL_LOOKUP");
long offset = unsafe().staticFieldOffset(implLookupField);
IMPL_LOOKUP = (MethodHandles.Lookup) unsafe().getObject(
unsafe().staticFieldBase(implLookupField), offset);
} catch (Throwable ignored) {
}
}
return IMPL_LOOKUP;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,5 @@ org.springframework.boot.SpringApplicationRunListener=\

# Initializers
org.springframework.context.ApplicationContextInitializer=\
com.alipay.sofa.boot.compatibility.CompatibilityVerifierApplicationContextInitializer
com.alipay.sofa.boot.compatibility.CompatibilityVerifierApplicationContextInitializer,\
com.alipay.sofa.boot.Initializer.DynamicModuleExportApplicationContextInitializer
Loading