├── example.gif ├── src ├── main │ ├── resources │ │ ├── banner.txt │ │ ├── application.yaml │ │ └── static │ │ │ └── index.html │ └── java │ │ └── com │ │ └── coalai │ │ ├── dto │ │ └── MessageHistory.java │ │ ├── CoalaiApplication.java │ │ ├── controller │ │ ├── SimpleController.java │ │ └── SessionController.java │ │ └── service │ │ └── SessionService.java └── test │ └── java │ └── com │ └── coalai │ └── CoalaiApplicationTests.java ├── .gitignore ├── README.md ├── docker-compose.yml ├── pom.xml └── LICENSE /example.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/qq418745/spring-ai-example/HEAD/example.gif -------------------------------------------------------------------------------- /src/main/resources/banner.txt: -------------------------------------------------------------------------------- 1 | .__ .__ 2 | ____ _________ | | _____ |__| 3 | _/ ___\/ _ \__ \ | | \__ \ | | 4 | \ \__( <_> / __ \| |__/ __ \| | 5 | \___ \____(____ |____(____ |__| 6 | \/ \/ \/ -------------------------------------------------------------------------------- /src/main/resources/application.yaml: -------------------------------------------------------------------------------- 1 | server: 2 | port: 8080 3 | spring: 4 | application: 5 | name: coalai 6 | profiles: 7 | active: dev 8 | ai: 9 | openai: 10 | base-url: https://api.openai.com 11 | api-key: Your API Key 12 | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled class file 2 | *.class 3 | 4 | # Log file 5 | *.log 6 | 7 | # BlueJ files 8 | *.ctxt 9 | 10 | # Mobile Tools for Java (J2ME) 11 | .mtj.tmp/ 12 | 13 | # Package Files # 14 | *.jar 15 | *.war 16 | *.nar 17 | *.ear 18 | *.zip 19 | *.tar.gz 20 | *.rar 21 | 22 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 23 | hs_err_pid* 24 | replay_pid* 25 | -------------------------------------------------------------------------------- /src/test/java/com/coalai/CoalaiApplicationTests.java: -------------------------------------------------------------------------------- 1 | package com.coalai; 2 | 3 | 4 | import lombok.extern.slf4j.Slf4j; 5 | 6 | import org.junit.jupiter.api.Test; 7 | import org.springframework.boot.test.context.SpringBootTest; 8 | 9 | 10 | 11 | @SpringBootTest 12 | @Slf4j 13 | public class CoalaiApplicationTests { 14 | 15 | @Test 16 | void test() { 17 | System.out.println("test is OK!"); 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # spring-ai-example 2 | 3 | ![示例GIF](./example.gif) 4 | ### 前提条件 5 | 6 | [application.yaml](src%2Fmain%2Fresources%2Fapplication.yaml) 中配置你的 API Key 启动即可 ~ 7 | 8 | ### START 9 | 10 | 访问这里开始测试效果! 11 | 12 | > http://localhost:8080/index.html 13 | 14 | ### 在线玩弄服务~ 15 | > https://ai.coala.top/index.html 16 | 17 | 18 | 19 | ### PS 20 | 21 | 如果因不可抗力须使用代理站, [application.yaml](src%2Fmain%2Fresources%2Fapplication.yaml) 中记得配置 base-url 22 | 23 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '3' 2 | services: 3 | coalai: 4 | container_name: coalai 5 | image: openjdk:17 6 | ports: 7 | - "8080:8080" 8 | volumes: 9 | - /etc/hosts:/etc/hosts 10 | - /etc/timezone:/etc/timezone 11 | - /root/springai:/root/springai 12 | working_dir: /root/springai 13 | command: 14 | [ "java","-jar","-server", "-Xms512m", "-Xmx1024m", 15 | "-Dspring.profiles.active=dev", 16 | "coalai.jar" ] 17 | 18 | -------------------------------------------------------------------------------- /src/main/java/com/coalai/dto/MessageHistory.java: -------------------------------------------------------------------------------- 1 | package com.coalai.dto; 2 | 3 | import lombok.Data; 4 | 5 | import java.util.List; 6 | 7 | 8 | @Data 9 | public class MessageHistory { 10 | 11 | List messages; 12 | 13 | String model; 14 | 15 | @Data 16 | public static class Message { 17 | List content; 18 | String role; 19 | 20 | @Data 21 | public static class Content { 22 | String type; 23 | String text; 24 | } 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /src/main/java/com/coalai/CoalaiApplication.java: -------------------------------------------------------------------------------- 1 | package com.coalai; 2 | 3 | import org.springframework.boot.SpringApplication; 4 | import org.springframework.boot.autoconfigure.SpringBootApplication; 5 | import org.springframework.scheduling.annotation.EnableScheduling; 6 | 7 | @SpringBootApplication 8 | @EnableScheduling 9 | public class CoalaiApplication { 10 | 11 | /** 12 | * OpenAI API key must be set 13 | * @param args 14 | */ 15 | public static void main(String[] args) { 16 | SpringApplication.run(CoalaiApplication.class, args); 17 | } 18 | 19 | } 20 | -------------------------------------------------------------------------------- /src/main/java/com/coalai/controller/SimpleController.java: -------------------------------------------------------------------------------- 1 | package com.coalai.controller; 2 | 3 | import lombok.AllArgsConstructor; 4 | import lombok.extern.slf4j.Slf4j; 5 | import org.springframework.ai.chat.StreamingChatClient; 6 | import org.springframework.ai.chat.prompt.Prompt; 7 | import org.springframework.ai.openai.OpenAiChatClient; 8 | import org.springframework.web.bind.annotation.*; 9 | import reactor.core.publisher.Flux; 10 | import reactor.core.publisher.Mono; 11 | 12 | import java.util.stream.Collectors; 13 | 14 | @RestController 15 | @AllArgsConstructor 16 | @RequestMapping("/simple") 17 | @Slf4j 18 | public class SimpleController { 19 | 20 | private final OpenAiChatClient chatClient; 21 | 22 | private final StreamingChatClient streamingChatClient; 23 | 24 | 25 | /** 26 | * 同步的 call 27 | * 28 | * @param message 29 | * @return 30 | */ 31 | @GetMapping(value = "/call") 32 | public String call(@RequestParam(value = "message", defaultValue = "说个笑话") String message) { 33 | return chatClient.call(new Prompt(message)) 34 | .getResults().stream() 35 | .map(r -> r.getOutput().getContent()) 36 | .collect(Collectors.joining()); 37 | } 38 | 39 | 40 | /** 41 | * 异步简单 Stream 写法 1 42 | * 43 | * @param message 44 | * @return 45 | */ 46 | @GetMapping(value = "/stream") 47 | public Flux stream(@RequestParam(value = "message", defaultValue = "说个猫咪笑话") String message) { 48 | return chatClient.stream(new Prompt(message)) 49 | .flatMap(chatResponse -> Flux.fromIterable(chatResponse.getResults())) 50 | .flatMap(content -> { 51 | String c = content.getOutput().getContent(); 52 | return c != null ? Mono.just(c) : Mono.empty(); 53 | } 54 | ); 55 | } 56 | 57 | /** 58 | * 异步简单 Stream 写法 2 59 | * 60 | * @param message 61 | * @return 62 | */ 63 | @GetMapping(value = "/stream2") 64 | public Flux stream2(@RequestParam(value = "message", defaultValue = "说个狗子笑话") String message) { 65 | return streamingChatClient.stream(message); 66 | } 67 | 68 | 69 | } -------------------------------------------------------------------------------- /src/main/java/com/coalai/service/SessionService.java: -------------------------------------------------------------------------------- 1 | package com.coalai.service; 2 | 3 | 4 | import com.coalai.dto.MessageHistory; 5 | import jakarta.servlet.http.HttpServletResponse; 6 | import lombok.AllArgsConstructor; 7 | import org.springframework.ai.chat.messages.*; 8 | import org.springframework.http.MediaType; 9 | import org.springframework.stereotype.Service; 10 | 11 | import java.util.ArrayList; 12 | 13 | @Service 14 | @AllArgsConstructor 15 | public class SessionService { 16 | 17 | private final HttpServletResponse response; 18 | 19 | /** 20 | * 给当前请求设置响应头 21 | */ 22 | public void setResponseHeader() { 23 | // Set the content type to text/event-stream 24 | response.setContentType(MediaType.TEXT_EVENT_STREAM_VALUE + "; charset=UTF-8"); 25 | response.addHeader("cache-control", "no-cache"); 26 | response.addHeader("connection", "keep-alive"); 27 | } 28 | 29 | public Message[] getMessages(MessageHistory messageHistory) { 30 | 31 | ArrayList messages = new ArrayList<>(); 32 | 33 | for (MessageHistory.Message message : messageHistory.getMessages()) { 34 | String role = message.getRole(); 35 | 36 | for (MessageHistory.Message.Content content : message.getContent()) { 37 | 38 | String type = content.getType(); 39 | // type 先不管 默认都是 text 40 | if (!"text".equals(type)) { 41 | throw new RuntimeException("Content type error: " + type); 42 | } 43 | 44 | if (MessageType.USER.getValue().equals(role)) { 45 | String text = content.getText(); 46 | UserMessage userMessage = new UserMessage(text); 47 | messages.add(userMessage); 48 | } else if (MessageType.SYSTEM.getValue().equals(role)) { 49 | String text = content.getText(); 50 | SystemMessage systemMessage = new SystemMessage(text); 51 | messages.add(systemMessage); 52 | } else if (MessageType.ASSISTANT.getValue().equals(role)) { 53 | String text = content.getText(); 54 | AssistantMessage assistantMessage = new AssistantMessage(text); 55 | messages.add(assistantMessage); 56 | } else { 57 | throw new RuntimeException("Role error: " + role); 58 | } 59 | } 60 | } 61 | 62 | return messages.toArray(new Message[messages.size()]); 63 | } 64 | } 65 | -------------------------------------------------------------------------------- /src/main/java/com/coalai/controller/SessionController.java: -------------------------------------------------------------------------------- 1 | package com.coalai.controller; 2 | 3 | 4 | import com.coalai.dto.MessageHistory; 5 | import com.coalai.service.SessionService; 6 | import jakarta.servlet.http.HttpServletResponse; 7 | import lombok.AllArgsConstructor; 8 | import lombok.extern.slf4j.Slf4j; 9 | import org.springframework.ai.chat.StreamingChatClient; 10 | import org.springframework.ai.chat.messages.*; 11 | import org.springframework.web.bind.annotation.PostMapping; 12 | import org.springframework.web.bind.annotation.RequestBody; 13 | import org.springframework.web.bind.annotation.RequestMapping; 14 | import org.springframework.web.bind.annotation.RestController; 15 | import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyEmitter; 16 | 17 | import java.io.IOException; 18 | import java.io.PrintWriter; 19 | 20 | @RestController 21 | @AllArgsConstructor 22 | @RequestMapping("/session") 23 | @Slf4j 24 | public class SessionController { 25 | 26 | private final StreamingChatClient streamingChatClient; 27 | private final HttpServletResponse response; 28 | private final SessionService sessionService; 29 | 30 | 31 | /** 32 | * 完全同步的,阻塞线程. 消耗资源但是足够的简单! 33 | * 34 | * @param messageHistory 35 | * @throws IOException 36 | * return 不遵守 SSE 协议规范, 直接返回结果! 37 | */ 38 | @PostMapping(value = "/sync/stream") 39 | public void syncStream2(@RequestBody MessageHistory messageHistory) throws IOException { 40 | 41 | sessionService.setResponseHeader(); 42 | 43 | // Get the PrintWriter to write the response 44 | PrintWriter writer = response.getWriter(); 45 | 46 | Message[] messages = sessionService.getMessages(messageHistory); 47 | 48 | streamingChatClient.stream(messages).map(message -> { 49 | // writer.write("data:" + message + "\n\n"); 这是遵守 SSE 规范的写法. 这里不遵守。 50 | writer.write(message); 51 | writer.flush(); // Make sure to flush after each message 52 | return message; 53 | 54 | }).blockLast(); // 阻塞线程!!! 55 | } 56 | 57 | 58 | /** 59 | * 完全异步的,不阻塞线程. 60 | * 61 | * @param messageHistory 62 | * @return 不遵守 SSE 协议规范, 直接返回结果! 63 | */ 64 | @PostMapping(value = "/async/stream") 65 | public ResponseBodyEmitter stream2(@RequestBody MessageHistory messageHistory) { 66 | 67 | sessionService.setResponseHeader(); 68 | 69 | final ResponseBodyEmitter emitter = new ResponseBodyEmitter(); 70 | 71 | // 模型名称, 按需处理 72 | String model = messageHistory.getModel(); 73 | 74 | Message[] messages = sessionService.getMessages(messageHistory); 75 | streamingChatClient.stream(messages) 76 | .subscribe( 77 | message -> { 78 | try { 79 | // emitter.send("data:" + message + "\n\n"); 这是遵守 SSE 规范的写法.这里不遵守。 80 | emitter.send(message); 81 | } catch (IOException e) { 82 | emitter.completeWithError(e); 83 | } 84 | }, 85 | error -> emitter.completeWithError(error), 86 | () -> emitter.complete() 87 | ); 88 | 89 | return emitter; 90 | } 91 | } 92 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | 6 | org.springframework.boot 7 | spring-boot-starter-parent 8 | 3.2.4 9 | 10 | 11 | com.coalai 12 | coalai 13 | 0.0.1-SNAPSHOT 14 | coalai 15 | coalai 16 | 17 | 17 18 | 19 | 20 | 21 | 22 | 23 | org.springframework.ai 24 | spring-ai-bom 25 | 26 | 1.0.0-SNAPSHOT 27 | pom 28 | import 29 | 30 | 31 | 32 | 33 | 34 | 35 | org.springframework.boot 36 | spring-boot-starter 37 | 38 | 39 | org.springframework.boot 40 | spring-boot-starter-web 41 | 42 | 43 | org.springframework.boot 44 | spring-boot-starter-test 45 | test 46 | 47 | 48 | org.projectlombok 49 | lombok 50 | 51 | 52 | cn.hutool 53 | hutool-all 54 | 5.8.26 55 | 56 | 57 | 58 | org.springframework.ai 59 | spring-ai-openai-spring-boot-starter 60 | 61 | 62 | 63 | 64 | ${project.name} 65 | 66 | 67 | org.springframework.boot 68 | spring-boot-maven-plugin 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | spring-milestones 77 | Spring Milestones 78 | https://repo.spring.io/milestone 79 | 80 | false 81 | 82 | 83 | 84 | spring-snapshots 85 | Spring Snapshots 86 | https://repo.spring.io/snapshot 87 | 88 | false 89 | 90 | 91 | 92 | 93 | 94 | -------------------------------------------------------------------------------- /src/main/resources/static/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Spring AI Test 7 | 8 | 9 | 21 | 22 | 23 | 24 | 25 | 26 |
27 |
28 |

simple

29 | 30 | 31 | 32 |
33 |
34 |

session stream

35 | 36 | 37 | 38 |
39 |
40 | 41 |
42 |
响应:
43 | 44 | 158 | 159 | 160 | 161 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------