添加 solonx-web-webservices-jakarta 模块

Author: noear

solon-jakarta-projects/solon-web/solonx-web-webservices-jakarta/src/main/java/org/noear/solon/web/webservices/WebServiceHelper.java

@@ -0,0 +1,60 @@
+/*
+ * Copyright 2017-2025 noear.org and authors
+ *
+ * Licensed 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
+ *
+ *      https://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 org.noear.solon.web.webservices;
+
+import org.apache.cxf.jaxws.JaxWsProxyFactoryBean;
+import org.apache.cxf.jaxws.JaxWsServerFactoryBean;
+
+
+/**
+ * WS 助手
+ *
+ * @author noear
+ * @since 1.0
+ */
+public class WebServiceHelper {
+    /**
+     * 发布 Web 服务
+     */
+    public static void publishWebService(String wsAddress, Object wsImplementInstance) {
+        publishWebService(wsAddress, wsImplementInstance, null);
+    }
+
+    /**
+     * 发布 Web 服务
+     */
+    public static void publishWebService(String wsAddress, Object wsImplementInstance, Class<?> wsInterfaceClass) {
+        if (wsInterfaceClass == null) {
+            wsInterfaceClass = wsImplementInstance.getClass();
+        }
+
+        JaxWsServerFactoryBean factory = new JaxWsServerFactoryBean();
+        factory.setAddress(wsAddress);               // 地址
+        factory.setServiceClass(wsInterfaceClass);   // 接口
+        factory.setServiceBean(wsImplementInstance); // 实现
+        factory.create();
+    }
+
+    /**
+     * 创建 Web 服务客户端
+     */
+    public static <T> T createWebClient(String wsAddress, Class<? extends T> interfaceClass) {
+        JaxWsProxyFactoryBean factory = new JaxWsProxyFactoryBean();
+        factory.setAddress(wsAddress);           // 地址
+        factory.setServiceClass(interfaceClass); // 接口
+        return factory.create(interfaceClass);
+    }
+}

solon-jakarta-projects/solon-web/solonx-web-webservices-jakarta/src/main/java/org/noear/solon/web/webservices/WebServiceReference.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2017-2025 noear.org and authors
+ *
+ * Licensed 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
+ *
+ *      https://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 org.noear.solon.web.webservices;
+
+import java.lang.annotation.*;
+
+/**
+ * WS 服务引用
+ *
+ * @author noear
+ * @since 1.0
+ */
+@Target({ElementType.FIELD})
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+public @interface WebServiceReference {
+    /**
+     * 服务地址
+     * */
+    String value();
+}

solon-jakarta-projects/solon-web/solonx-web-webservices-jakarta/src/main/java/org/noear/solon/web/webservices/integration/WebServiceBeanBuilder.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2017-2025 noear.org and authors
+ *
+ * Licensed 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
+ *
+ *      https://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 org.noear.solon.web.webservices.integration;
+
+import jakarta.jws.WebService;
+import org.noear.solon.core.BeanBuilder;
+import org.noear.solon.core.BeanWrap;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * @author noear
+ * @since 1.0
+ */
+public class WebServiceBeanBuilder implements BeanBuilder<WebService> {
+    private List<BeanWrap> wsBeanWarps = new ArrayList<>();
+
+    public List<BeanWrap> getWsBeanWarps() {
+        return wsBeanWarps;
+    }
+
+    @Override
+    public void doBuild(Class<?> clz, BeanWrap bw, WebService anno) throws Throwable {
+        if (clz.isInterface() == false) {
+            wsBeanWarps.add(bw);
+        }
+    }
+}

solon-jakarta-projects/solon-web/solonx-web-webservices-jakarta/src/main/java/org/noear/solon/web/webservices/integration/WebServiceContainerInitializerImpl.java

@@ -0,0 +1,57 @@
+/*
+ * Copyright 2017-2025 noear.org and authors
+ *
+ * Licensed 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
+ *
+ *      https://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 org.noear.solon.web.webservices.integration;
+
+import org.noear.solon.Solon;
+import org.noear.solon.Utils;
+
+import jakarta.servlet.ServletContainerInitializer;
+import jakarta.servlet.ServletContext;
+import jakarta.servlet.ServletException;
+import jakarta.servlet.ServletRegistration;
+import java.util.Set;
+
+/**
+ * @author noear
+ * @since 1.0
+ */
+public class WebServiceContainerInitializerImpl implements ServletContainerInitializer {
+    @Override
+    public void onStartup(Set<Class<?>> set, ServletContext servletContext) throws ServletException {
+        //@WebServlet(name = "ws", urlPatterns = "/ws/*", loadOnStartup = 0)
+        String path = Solon.cfg().get("server.webservices.path");
+
+        if (Utils.isEmpty(path)) {
+            path = "/ws/*";
+        } else {
+            if (path.startsWith("/") == false) {
+                path = "/" + path;
+            }
+
+            if (path.endsWith("/")) {
+                path = path + "*";
+            } else {
+                path = path + "/*";
+            }
+        }
+
+        ServletRegistration.Dynamic registration = servletContext.addServlet("WebServiceServlet", WebServiceServlet.class);
+        if (registration != null) {
+            registration.setLoadOnStartup(0);
+            registration.addMapping(path);
+        }
+    }
+}

solon-jakarta-projects/solon-web/solonx-web-webservices-jakarta/src/main/java/org/noear/solon/web/webservices/integration/WebServicePlugin.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2017-2025 noear.org and authors
+ *
+ * Licensed 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
+ *
+ *      https://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 org.noear.solon.web.webservices.integration;
+
+import org.noear.solon.core.AppContext;
+import org.noear.solon.core.Plugin;
+import org.noear.solon.web.webservices.WebServiceReference;
+
+import jakarta.jws.WebService;
+import jakarta.servlet.ServletContainerInitializer;
+
+/**
+ * @author noear
+ * @since 1.0
+ */
+public class WebServicePlugin implements Plugin {
+    @Override
+    public void start(AppContext context) throws Throwable {
+        WebServiceBeanBuilder wsBeanBuilder = new WebServiceBeanBuilder();
+
+        //注册 Bean
+        context.wrapAndPut(ServletContainerInitializer.class, new WebServiceContainerInitializerImpl());
+        context.wrapAndPut(WebServiceBeanBuilder.class, wsBeanBuilder);
+
+        //添加 Anno 处理
+        context.beanBuilderAdd(WebService.class, wsBeanBuilder);
+        context.beanInjectorAdd(WebServiceReference.class, new WebServiceReferenceBeanInjector());
+    }
+}

solon-jakarta-projects/solon-web/solonx-web-webservices-jakarta/src/main/java/org/noear/solon/web/webservices/integration/WebServiceReferenceBeanInjector.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2017-2025 noear.org and authors
+ *
+ * Licensed 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
+ *
+ *      https://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 org.noear.solon.web.webservices.integration;
+
+import org.noear.solon.core.BeanInjector;
+import org.noear.solon.core.VarHolder;
+import org.noear.solon.web.webservices.WebServiceReference;
+import org.noear.solon.web.webservices.WebServiceHelper;
+
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+
+/**
+ * @author noear
+ * @since 1.0
+ */
+public class WebServiceReferenceBeanInjector implements BeanInjector<WebServiceReference> {
+    private Map<String, Object> cached = new ConcurrentHashMap<>();
+
+    @Override
+    public void doInject(VarHolder varH, WebServiceReference anno) {
+        if (varH.getType().isInterface()) {
+
+            String wsKey = anno.value() + "#" + varH.getType().getTypeName();
+            Object wsProxy = cached.computeIfAbsent(wsKey, k -> WebServiceHelper.createWebClient(anno.value(), varH.getType()));
+
+            varH.setValue(wsProxy);
+        }
+    }
+}

solon-jakarta-projects/solon-web/solonx-web-webservices-jakarta/src/main/java/org/noear/solon/web/webservices/integration/WebServiceServlet.java

@@ -0,0 +1,82 @@
+/*
+ * Copyright 2017-2025 noear.org and authors
+ *
+ * Licensed 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
+ *
+ *      https://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 org.noear.solon.web.webservices.integration;
+
+import org.apache.cxf.Bus;
+import org.apache.cxf.BusFactory;
+import org.apache.cxf.transport.servlet.CXFNonSpringServlet;
+import org.noear.solon.Solon;
+import org.noear.solon.Utils;
+import org.noear.solon.core.BeanWrap;
+import org.noear.solon.web.webservices.WebServiceHelper;
+
+import jakarta.jws.WebService;
+import jakarta.servlet.ServletConfig;
+
+public class WebServiceServlet extends CXFNonSpringServlet {
+    @Override
+    protected void loadBus(ServletConfig sc) {
+        // 设置 Bus
+        setBus(sc);
+        // 发布 Web 服务
+        publishWebService();
+    }
+
+    private void setBus(ServletConfig sc) {
+        super.loadBus(sc);
+        Bus bus = getBus();
+        BusFactory.setDefaultBus(bus);
+    }
+
+    private void publishWebService() {
+        // 遍历所有标注了 @WebService 注解的接口
+        WebServiceBeanBuilder wsBeanBuilder = Solon.context().getBean(WebServiceBeanBuilder.class);
+
+        for (BeanWrap bw : wsBeanBuilder.getWsBeanWarps()) {
+            // 获取 name 属性
+            WebService anno = bw.clz().getAnnotation(WebService.class);
+            String name = Utils.annoAlias(anno.name(), anno.serviceName());
+            // 获取 Web 服务地址
+            String wsAddress = getAddress(name, bw.clz());
+            // 获取 Web 服务实现类（找到唯一的实现类）
+            Class<?> wsImplementClass = bw.clz();
+            // 获取实现类的实例
+            Object wsImplementInstance = bw.raw();
+            // 发布 Web 服务
+            WebServiceHelper.publishWebService(wsAddress, wsImplementInstance, wsImplementClass);
+
+        }
+    }
+
+    private String getAddress(String value, Class<?> wsInterfaceClass) {
+        String address;
+        if (Utils.isNotEmpty(value)) {
+            // 若不为空，则为 value
+            address = value;
+        } else {
+            // 若为空，则为类名
+            address = wsInterfaceClass.getSimpleName();
+        }
+
+        // 确保最前面只有一个 /
+        if (!address.startsWith("/")) {
+            address = "/" + address;
+        }
+
+        address = address.replaceAll("\\/+", "/");
+        return address;
+    }
+}

solon-jakarta-projects/solon-web/solonx-web-webservices-jakarta/src/main/resources/META-INF/solon/solon-web-webservices.properties

@@ -0,0 +1,2 @@
+solon.plugin=org.noear.solon.web.webservices.integration.WebServicePlugin
+solon.plugin.priority=1

solon-jakarta-projects/solon-web/solonx-web-webservices-jakarta/src/test/java/demo/client/ClientTest.java

@@ -0,0 +1,22 @@
+package demo.client;
+
+
+import org.noear.solon.web.webservices.WebServiceHelper;
+
+import jakarta.jws.WebMethod;
+import jakarta.jws.WebService;
+
+public class ClientTest {
+    public static void main(String[] args) {
+        String wsAddress = "http://localhost:8080/ws/HelloService";
+        HelloService helloService = WebServiceHelper.createWebClient(wsAddress, HelloService.class);
+
+        System.out.println("rst::" + helloService.hello("noear"));
+    }
+
+    @WebService(serviceName = "HelloService", targetNamespace = "http://demo.solon.io")
+    public interface HelloService {
+        @WebMethod
+        String hello(String name);
+    }
+}