-
Notifications
You must be signed in to change notification settings - Fork 280
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1011 from zlxs1317169/dubboword
Add RpcWordDocBuilder to support generate word of dubbo
- Loading branch information
Showing
7 changed files
with
1,819 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
148 changes: 148 additions & 0 deletions
148
src/main/java/com/ly/doc/builder/rpc/RpcWordDocBuilder.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| /* | ||
| * Copyright (C) 2018-2024 smart-doc | ||
| * | ||
| * 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.ly.doc.builder.rpc; | ||
|
|
||
| import com.ly.doc.constants.DocGlobalConstants; | ||
| import com.ly.doc.helper.JavaProjectBuilderHelper; | ||
| import com.ly.doc.model.ApiConfig; | ||
| import com.ly.doc.model.rpc.RpcApiDoc; | ||
| import com.thoughtworks.qdox.JavaProjectBuilder; | ||
| import org.beetl.core.Template; | ||
|
|
||
| import java.io.InputStream; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Paths; | ||
| import java.util.List; | ||
| import java.util.Objects; | ||
| import java.util.zip.ZipEntry; | ||
| import java.util.zip.ZipInputStream; | ||
| import java.util.zip.ZipOutputStream; | ||
|
|
||
| /** | ||
| * Dubbo Word doc builder | ||
| * | ||
| * @author <a href="[email protected]">wangaiping</a> | ||
| * @since 3.0.10 | ||
| */ | ||
| public class RpcWordDocBuilder { | ||
|
|
||
| /** | ||
| * template docx | ||
| */ | ||
| private static final String TEMPLATE_DOCX = "template/dubbo/template.docx"; | ||
|
|
||
| /** | ||
| * build docx file name | ||
| */ | ||
| private static final String INDEX_DOC = "rpc-index.docx"; | ||
|
|
||
| /** | ||
| * build error code docx file name | ||
| */ | ||
| private static final String BUILD_ERROR_DOCX = "error.docx"; | ||
|
|
||
| /** | ||
| * build directory data docx file name | ||
| */ | ||
| private static final String BUILD_DICT_DOCX = "dict.docx"; | ||
|
|
||
| /** | ||
| * private constructor | ||
| */ | ||
| private RpcWordDocBuilder() { | ||
| throw new IllegalStateException("Utility class"); | ||
| } | ||
|
|
||
| /** | ||
| * build dubbo api | ||
| * @param config config | ||
| * @throws Exception exception | ||
| */ | ||
| public static void buildApiDoc(ApiConfig config) throws Exception { | ||
| JavaProjectBuilder javaProjectBuilder = JavaProjectBuilderHelper.create(); | ||
| buildApiDoc(config, javaProjectBuilder); | ||
| } | ||
|
|
||
| /** | ||
| * build dubbo api | ||
| * @param config config | ||
| * @param javaProjectBuilder javaProjectBuilder | ||
| * @throws Exception exception | ||
| */ | ||
| public static void buildApiDoc(ApiConfig config, JavaProjectBuilder javaProjectBuilder) throws Exception { | ||
| RpcDocBuilderTemplate rpcDocBuilderTemplate = new RpcDocBuilderTemplate(); | ||
| List<RpcApiDoc> apiDocList = rpcDocBuilderTemplate.getApiDoc(false, true, false, config, javaProjectBuilder); | ||
|
|
||
| if (config.isAllInOne()) { | ||
| String docName = rpcDocBuilderTemplate.allInOneDocName(config, INDEX_DOC, | ||
| DocGlobalConstants.WORD_DOC_EXTENSION); | ||
| apiDocList = rpcDocBuilderTemplate.handleApiGroup(apiDocList, config); | ||
| Template tpl = rpcDocBuilderTemplate.buildAllInOneWord(apiDocList, config, javaProjectBuilder, | ||
| DocGlobalConstants.RPC_ALL_IN_ONE_WORD_TPL, docName); | ||
|
|
||
| String outPath = config.getOutPath(); | ||
| copyAndReplaceDocx(tpl.render(), outPath + DocGlobalConstants.FILE_SEPARATOR + docName); | ||
| } | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * replace docx content | ||
| * @param content doc content | ||
| * @param docxOutputPath docx output path | ||
| * @throws Exception exception | ||
| * @since 1.0.0 | ||
| */ | ||
| public static void copyAndReplaceDocx(String content, String docxOutputPath) throws Exception { | ||
| InputStream resourceAsStream = RpcWordDocBuilder.class.getClassLoader().getResourceAsStream(TEMPLATE_DOCX); | ||
| Objects.requireNonNull(resourceAsStream, "dubbo word template docx is not found"); | ||
|
|
||
| ZipInputStream zipInputStream = new ZipInputStream(resourceAsStream); | ||
| ZipOutputStream zipOutputStream = new ZipOutputStream(Files.newOutputStream(Paths.get(docxOutputPath))); | ||
| // Traverse the files in the compressed package | ||
| ZipEntry entry; | ||
| while ((entry = zipInputStream.getNextEntry()) != null) { | ||
| String entryName = entry.getName(); | ||
| // copy fix the bug: invalid entry compressed size | ||
| zipOutputStream.putNextEntry(new ZipEntry(entryName)); | ||
| if ("word/document.xml".equals(entryName)) { | ||
| byte[] bytes = content.getBytes(StandardCharsets.UTF_8); | ||
| zipOutputStream.write(bytes, 0, bytes.length); | ||
| } | ||
| else { | ||
| // copy | ||
| byte[] buffer = new byte[1024]; | ||
| int len; | ||
| while ((len = zipInputStream.read(buffer)) > 0) { | ||
| zipOutputStream.write(buffer, 0, len); | ||
| } | ||
| } | ||
|
|
||
| zipOutputStream.closeEntry(); | ||
| zipInputStream.closeEntry(); | ||
| } | ||
|
|
||
| zipInputStream.close(); | ||
| zipOutputStream.close(); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.