├── .gitignore ├── LICENSE ├── README.md ├── project ├── Build.scala ├── build.properties └── plugins.sbt └── src └── main ├── resources ├── reference.conf └── testfile.txt └── scala └── akkahttp ├── FileDirective.scala ├── FileServer.scala └── TestApp.scala /.gitignore: -------------------------------------------------------------------------------- 1 | # GearPump 2 | logs/ 3 | 4 | # Scala 5 | *.class 6 | *.log 7 | .cache/ 8 | .history/ 9 | .lib/ 10 | dist/* 11 | target/ 12 | lib_managed/ 13 | src_managed/ 14 | project/boot/ 15 | project/plugins/project/ 16 | .scala_dependencies 17 | .worksheet 18 | 19 | # Java 20 | *.jar 21 | *.war 22 | *.ear 23 | hs_err_pid* 24 | 25 | # IntelliJ 26 | /*.iml 27 | out/ 28 | .idea/ 29 | *.ipr 30 | *.iws 31 | .idea_modules/ 32 | atlassian-ide-plugin.xml 33 | com_crashlytics_export_strings.xml 34 | 35 | # Eclipse 36 | .metadata 37 | .project 38 | .cache 39 | .classpath 40 | bin/ 41 | tmp/ 42 | *.tmp 43 | *.bak 44 | *.swp 45 | *~.nib 46 | local.properties 47 | .settings/ 48 | .loadpath 49 | .externalToolBuilders/ 50 | *.launch 51 | .target -------------------------------------------------------------------------------- /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 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # akka-http-file-server 2 | 3 | A file server example to download/upload large files with akka-http. 4 | 5 | ## How to use 6 | ```sbt "run-main akkahttp.TestApp"``` 7 | 8 | Then Browser http://127.0.0.1:9112/ 9 | 10 | ## How it is implemented? 11 | We create a akka-http DSL for this, so it is super easy to create a http file server: 12 | 13 | ``` 14 | val route: Route = { 15 | path("upload") { 16 | uploadFile { fileMap => 17 | complete(ToResponseMarshallable(fileMap)) 18 | } 19 | } ~ 20 | path("download") { 21 | parameters("file") { file => 22 | downloadFile(file) 23 | } 24 | } 25 | ``` 26 | 27 | ## Used by 28 | Big data streaming engine over Akka: 29 | 30 | Project Gearpump: https://github.com/gearpump/gearpump 31 | -------------------------------------------------------------------------------- /project/Build.scala: -------------------------------------------------------------------------------- 1 | import com.typesafe.sbt.SbtPgp.autoImport._ 2 | import de.johoop.jacoco4sbt.JacocoPlugin.jacoco 3 | import sbt.Keys._ 4 | import sbt._ 5 | import xerial.sbt.Sonatype._ 6 | 7 | object Build extends sbt.Build { 8 | val copySharedSourceFiles = TaskKey[Unit]("copied shared services source code") 9 | 10 | val akkaVersion = "2.3.6" 11 | val slf4jVersion = "1.7.7" 12 | 13 | val commonSettings = Seq(jacoco.settings:_*) ++ sonatypeSettings ++ net.virtualvoid.sbt.graph.Plugin.graphSettings ++ 14 | Seq( 15 | scalaVersion := "2.11.5", 16 | resolvers ++= Seq( 17 | "patriknw at bintray" at "http://dl.bintray.com/patriknw/maven", 18 | "maven-repo" at "http://repo.maven.apache.org/maven2", 19 | "maven1-repo" at "http://repo1.maven.org/maven2", 20 | "maven2-repo" at "http://mvnrepository.com/artifact", 21 | "sonatype" at "https://oss.sonatype.org/content/repositories/releases", 22 | "bintray/non" at "http://dl.bintray.com/non/maven" 23 | ) 24 | ) 25 | 26 | val coreDependencies = Seq( 27 | libraryDependencies ++= Seq( 28 | "org.slf4j" % "slf4j-api" % slf4jVersion, 29 | "org.slf4j" % "slf4j-log4j12" % slf4jVersion, 30 | "com.typesafe.akka" %% "akka-actor" % akkaVersion, 31 | "com.typesafe.akka" %% "akka-remote" % akkaVersion, 32 | "com.typesafe.akka" %% "akka-agent" % akkaVersion, 33 | "com.typesafe.akka" %% "akka-slf4j" % akkaVersion, 34 | "com.typesafe.akka" %% "akka-http-experimental" % "1.0", 35 | "com.typesafe.akka" %% "akka-http-core-experimental" % "1.0", 36 | "com.typesafe.akka" %% "akka-stream-experimental" % "1.0", 37 | "com.typesafe.akka" %% "akka-http-spray-json-experimental"% "1.0", 38 | "com.typesafe.akka" %% "akka-kernel" % akkaVersion 39 | ) 40 | ) 41 | 42 | lazy val root = Project( 43 | id = "akka-http-file-server", 44 | base = file("."), 45 | settings = commonSettings ++ coreDependencies 46 | ) 47 | } -------------------------------------------------------------------------------- /project/build.properties: -------------------------------------------------------------------------------- 1 | # 2 | # Licensed to the Apache Software Foundation (ASF) under one 3 | # or more contributor license agreements. See the NOTICE file 4 | # distributed with this work for additional information 5 | # regarding copyright ownership. The ASF licenses this file 6 | # to you under the Apache License, Version 2.0 (the 7 | # "License"); you may not use this file except in compliance 8 | # with the License. You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | sbt.version=0.13.7 20 | -------------------------------------------------------------------------------- /project/plugins.sbt: -------------------------------------------------------------------------------- 1 | addSbtPlugin("org.scala-js" % "sbt-scalajs" % "0.6.4") 2 | 3 | addSbtPlugin("com.eed3si9n" % "sbt-assembly" % "0.11.2") 4 | 5 | resolvers += Resolver.url("fvunicorn", url("http://dl.bintray.com/fvunicorn/sbt-plugins"))(Resolver.ivyStylePatterns) 6 | 7 | addSbtPlugin("io.gearpump.sbt" % "sbt-pack" % "0.7.6") 8 | 9 | addSbtPlugin("de.johoop" % "jacoco4sbt" % "2.1.6") 10 | 11 | addSbtPlugin("com.gilt" % "sbt-dependency-graph-sugar" % "0.7.4") 12 | 13 | addSbtPlugin("org.xerial.sbt" % "sbt-sonatype" % "0.2.1") 14 | 15 | addSbtPlugin("com.jsuereth" % "sbt-pgp" % "1.0.0") 16 | 17 | addSbtPlugin("com.github.gseitz" % "sbt-release" % "0.8.5") 18 | 19 | resolvers += Classpaths.sbtPluginReleases 20 | 21 | addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.1.0") 22 | 23 | addSbtPlugin("com.typesafe.sbteclipse" % "sbteclipse-plugin" % "3.0.0") 24 | -------------------------------------------------------------------------------- /src/main/resources/reference.conf: -------------------------------------------------------------------------------- 1 | akka { 2 | http { 3 | client { 4 | parsing { 5 | max-content-length = 2048m 6 | } 7 | } 8 | server { 9 | parsing { 10 | max-content-length = 2048m 11 | } 12 | } 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /src/main/resources/testfile.txt: -------------------------------------------------------------------------------- 1 | THIS is a test FILE -------------------------------------------------------------------------------- /src/main/scala/akkahttp/FileDirective.scala: -------------------------------------------------------------------------------- 1 | package akkahttp 2 | 3 | import java.io.File 4 | 5 | import akka.http.scaladsl.model.{HttpEntity, MediaTypes, Multipart} 6 | import akka.http.scaladsl.server.Directives._ 7 | import akka.http.scaladsl.server._ 8 | import akka.stream.Materializer 9 | import akka.stream.io.{SynchronousFileSink, SynchronousFileSource} 10 | 11 | import scala.concurrent.{ExecutionContext, Future} 12 | 13 | 14 | object FileDirective { 15 | 16 | //form field name 17 | type Name = String 18 | 19 | case class FileInfo(fileName: String, targetFile: String, length: Long) 20 | 21 | private def uploadFileImpl(implicit mat: Materializer, ec: ExecutionContext): Directive1[Future[Map[Name, FileInfo]]] = { 22 | Directive[Tuple1[Future[Map[Name, FileInfo]]]] { inner => 23 | entity(as[Multipart.FormData]) { (formdata: Multipart.FormData) => 24 | val fileNameMap = formdata.parts.mapAsync(1) { p => 25 | if (p.filename.isDefined) { 26 | val targetPath = File.createTempFile(s"userfile_${p.name}_${p.filename.getOrElse("")}", "") 27 | val written = p.entity.dataBytes.runWith(SynchronousFileSink(targetPath)) 28 | written.map(written => 29 | Map(p.name -> FileInfo(p.filename.get, targetPath.getAbsolutePath, written))) 30 | } else { 31 | Future(Map.empty[Name, FileInfo]) 32 | } 33 | }.runFold(Map.empty[Name, FileInfo])((set, value) => set ++ value) 34 | inner(Tuple1(fileNameMap)) 35 | } 36 | } 37 | } 38 | 39 | def uploadFile: Directive1[Map[Name, FileInfo]] = { 40 | Directive[Tuple1[Map[Name, FileInfo]]] { inner => 41 | extractMaterializer {implicit mat => 42 | extractExecutionContext {implicit ec => 43 | uploadFileImpl(mat, ec) { filesFuture => 44 | ctx => { 45 | filesFuture.map(map => inner(Tuple1(map))).flatMap(route => route(ctx)) 46 | } 47 | } 48 | } 49 | } 50 | } 51 | } 52 | 53 | def downloadFile(file: String): Route = { 54 | val f = new File(file) 55 | val responseEntity = HttpEntity( 56 | MediaTypes.`application/octet-stream`, 57 | f.length, 58 | SynchronousFileSource(f, chunkSize = 262144)) 59 | complete(responseEntity) 60 | } 61 | } -------------------------------------------------------------------------------- /src/main/scala/akkahttp/FileServer.scala: -------------------------------------------------------------------------------- 1 | package akkahttp 2 | 3 | import java.io.File 4 | 5 | import akka.actor.ActorSystem 6 | import akka.http.scaladsl.Http 7 | import akka.http.scaladsl.Http.ServerBinding 8 | import akka.http.scaladsl.marshalling.{ToResponseMarshallable, Marshal} 9 | import akka.http.scaladsl.model.Uri.Path 10 | import akka.http.scaladsl.model.{HttpEntity, HttpRequest, MediaTypes, Multipart, _} 11 | import akka.http.scaladsl.server.Directives._ 12 | import akka.http.scaladsl.server._ 13 | import akka.http.scaladsl.unmarshalling.Unmarshal 14 | import akka.stream.ActorMaterializer 15 | import akka.stream.io.{SynchronousFileSink, SynchronousFileSource} 16 | import akka.stream.scaladsl.{Sink, Source} 17 | import akkahttp.FileDirective.FileInfo 18 | import spray.json.{JsonFormat, RootJsonFormat} 19 | import scala.concurrent.{ExecutionContext, Future} 20 | import spray.json.DefaultJsonProtocol._ 21 | import akka.http.scaladsl.marshallers.sprayjson.SprayJsonSupport._ 22 | import FileDirective._ 23 | 24 | class FileServer(system: ActorSystem, host: String, port: Int) { 25 | import system.dispatcher 26 | implicit val actorSystem = system 27 | implicit val materializer = ActorMaterializer() 28 | import FileServer.fileInfoFormat 29 | 30 | val route: Route = { 31 | path("upload") { 32 | uploadFile { fileMap => 33 | complete(ToResponseMarshallable(fileMap)) 34 | } 35 | } ~ 36 | path("download") { 37 | parameters("file") { file => 38 | downloadFile(file) 39 | } 40 | } ~ 41 | pathEndOrSingleSlash { 42 | val entity = HttpEntity(MediaTypes.`text/html`, 43 | """ 44 | | 45 | |