Kingfisher

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 24,389 Open GitHub ↗

웹에서 이미지를 다운로드하고 캐싱하기 위한 가볍고 순수 Swift로 작성된 라이브러리입니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Kingfisher는 웹에서 이미지를 다운로드하고 캐싱하기 위한 강력하고 순수 Swift로 작성된 라이브러리입니다. 차세대 앱에서 원격 이미지를 다룰 때 순수 Swift 방식을 사용할 수 있는 기회를 제공합니다.

## 기능

- [x] 비동기 이미지 다운로드 및 캐싱.
- [x] `URLSession` 기반 네트워킹 또는 로컬에서 제공된 데이터로부터 이미지 로드.
- [x] 유용한 이미지 프로세서 및 필터 제공.
- [x] 메모리와 디스크 모두를 위한 다중 계층 하이브리드 캐시.
- [x] 캐시 동작에 대한 세밀한 제어. 사용자 지정 가능한 만료일 및 크기 제한.
- [x] 디스크 캐시 검사 시 호출자 스레드가 차단되는 것을 방지하기 위한 `KingfisherManager`의 선택적 비동기 캐시 프로빙.
- [x] 성능 향상을 위한 취소 가능한 다운로드 및 이전에 다운로드한 콘텐츠 자동 재사용.
- [x] 독립적인 컴포넌트. 필요에 따라 다운로더, 캐싱 시스템, 이미지 프로세서를 따로 사용할 수 있습니다.
- [x] 앱 성능 향상을 위한 이미지 사전 로딩 및 캐시로부터의 표시.
- [x] URL에서 이미지를 직접 설정하기 위한 `UIImageView`, `NSImageView`, `NSButton`, `UIButton`, `NSTextAttachment`, `WKInterfaceImage`, `TVMonogramView`, `CPListItem` 확장 제공.
- [x] 이미지 설정 시 내장 전환 애니메이션.
- [x] 이미지 로딩 중 사용자 지정 가능한 플레이스홀더 및 인디케이터.
- [x] 손쉬운 확장 가능한 이미지 처리 및 이미지 포맷.
- [x] 저데이터 모드(Low Data Mode) 지원.
- [x] SwiftUI 지원.
- [x] Swift 6 및 Swift Concurrency (엄격 모드) 준비 완료.
- [x] 라이브 포토(Live Photo) 로드 및 캐시.

### Kingfisher 101

가장 간단한 사용 사례는 `UIImageView` 확장을 사용하여 이미지 뷰에 이미지를 설정하는 것입니다:

```swift
import Kingfisher

let url = URL(string: "https://example.com/image.png")
imageView.kf.setImage(with: url)
```

Kingfisher는 `url`에서 이미지를 다운로드하여 메모리 캐시와 디스크 캐시 모두에 보낸 후 `imageView`에 표시합니다. 
나중에 동일한 URL로 설정하면 이미지가 캐시에서 검색되어 즉시 표시됩니다.

SwiftUI를 사용하는 경우에도 다음과 같이 작동합니다:

```swift
var body: some View {
    KFImage(URL(string: "https://example.com/image.png")!)
}
```

### 더 고급 예제

강력한 옵션을 사용하면 Kingfisher를 통해 복잡한 작업을 간단하게 처리할 수 있습니다. 예를 들어, 아래의 코드는:

1. 고해상도 이미지를 다운로드합니다.
2. 이미지 뷰 크기에 맞게 다운샘플링합니다.
3. 지정된 반경으로 모서리를 둥글게 만듭니다.
4. 다운로드하는 동안 시스템 인디케이터와 플레이스홀더 이미지를 표시합니다.
5. 준비가 되면 "페이드 인" 효과와 함께 작은 썸네일 이미지에 애니메이션을 적용합니다. 
6. 상세 뷰에서 다시 다운로드하는 것을 방지하기 위해 원본 대형 이미지도 나중에 사용할 수 있도록 디스크에 캐시합니다.
7. 작업이 성공하든 실패하든 완료되면 콘솔 로그가 출력됩니다.

```swift
let url = URL(string: "https://example.com/high_resolution_image.png")
let processor = DownsamplingImageProcessor(size: imageView.bounds.size)
             |> RoundCornerImageProcessor(cornerRadius: 20)
imageView.kf.indicatorType = .activity
imageView.kf.setImage(
    with: url,
    placeholder: UIImage(named: "placeholderImage"),
    options: [
        .processor(processor),
        .scaleFactor(UIScreen.main.scale),
        .transition(.fade(1)),
        .cacheOriginalImage
    ])
{
    result in
    switch result {
    case .success(let value):
        print("Task done for: \(value.source.url?.absoluteString ?? "")")
    case .failure(let error):
        print("Job failed: \(error.localizedDescription)")
    }
}
```

일상적인 개발 업무에서 흔히 마주치는 상황입니다. Kingfisher 없이 이 작업을 하려면 얼마나 많은 코드를 작성해야 하는지 생각해 보세요!

### 메서드 체이닝

`kf` 확장을 선호하지 않는다면, `KF` 빌더를 사용하여 메서드 호출을 체이닝하는 방식을 선호할 수도 있습니다. 아래의 코드는 정확히 동일한 작업을 수행합니다:

```swift
// `kf` 확장 사용
imageView.kf.setImage(
    with: url,
    placeholder: placeholderImage,
    options: [
        .processor(processor),
        .loadDiskFileSynchronously,
        .cacheOriginalImage,
        .transition(.fade(0.25)),
        .lowDataMode(.network(lowResolutionURL))
    ],
    progressBlock: { receivedSize, totalSize in
        // 진행 상황 업데이트
    },
    completionHandler: { result in
        // 완료
    }
)

// `KF` 빌더 사용
KF.url(url)
  .placeholder(placeholderImage)
  .setProcessor(processor)
  .loadDiskFileSynchronously()
  .cacheMemoryOnly()
  .fade(duration: 0.25)
  .lowDataModeSource(.network(lowResolutionURL))
  .onProgress { receivedSize, totalSize in  }
  .onSuccess { result in  }
  .onFailure { error in }
  .set(to: imageView)
```

더 좋은 점은, 나중에 SwiftUI로 전환하고 싶을 때 위 코드의 `KF`를 `KFImage`로 바꾸기만 하면 끝난다는 것입니다:

```swift
struct ContentView: View {
    var body: some View {
        KFImage.url(url)
          .placeholder(placeholderImage)
          .setProcessor(processor)
          .loadDiskFileSynchronously()
          .cacheMemoryOnly()
          .fade(duration: 0.25)
          .lowDataModeSource(.network(lowResolutionURL))
          .onProgress { receivedSize, totalSize in  }
          .onSuccess { result in  }
          .onFailure { error in }
    }
}
```

## 요구 사항

### Kingfisher 8.0

- (UIKit/AppKit) iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+ / visionOS 1.0+
- (SwiftUI) iOS 14.0+ / macOS 11.0+ / tvOS 14.0+ / watchOS 7.0+ / visionOS 1.0+
- Swift 5.9+

### Kingfisher 7.0

- (UIKit/AppKit) iOS 12.0+ / macOS 10.14+ / tvOS 12.0+ / watchOS 5.0+ / visionOS 1.0+
- (SwiftUI) iOS 14.0+ / macOS 11.0+ / tvOS 14.0+ / watchOS 7.0+ / visionOS 1.0+
- Swift 5.0+

### 설치

프레임워크를 설치하고 사용하려면 다음 튜토리얼 중 하나를 참조하세요:

- [UIKit Tutorial](https://swiftpackageindex.com/onevcat/kingfisher/master/tutorials/kingfisher/gettingstarteduikit)
- [SwiftUI Tutorial](https://swiftpackageindex.com/onevcat/kingfisher/master/tutorials/kingfisher/gettingstartedswiftui)

또는 아래 방법 중 하나를 따를 수도 있습니다.

#### Swift Package Manager

- File > Swift Packages > Add Package Dependency
- `https://github.com/onevcat/Kingfisher.git` 추가
- "8.0.0"과 함께 "Up to Next Major" 선택

#### CocoaPods

```ruby
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '13.0'
use_frameworks!

target 'MyApp' do
  pod 'Kingfisher', '~> 8.0'
end
```

#### 사전 빌드된 프레임워크

1. 릴리스 페이지를 열고 에셋 섹션에서 최신 버전의 Kingfisher를 다운로드합니다. 
2. `Kingfisher.xcframework`를 프로젝트로 드래그하여 타겟(일반적으로 앱 타겟)에 추가합니다.
3. 타겟을 선택하고 "General" 탭의 "Frameworks, Libraries, and Embedded Content" 섹션에서 `Embed Without Signing`을 Kingfisher로 설정합니다.

## 문서

문서와 튜토리얼을 확인하세요:

- [Documentation Home](https://swiftpackageindex.com/onevcat/kingfisher/master/documentation/kingfisher)
- [Getting Started](https://swiftpackageindex.com/onevcat/kingfisher/master/documentation/kingfisher/gettingstarted)
    - [UIKit Tutorial](https://swiftpackageindex.com/onevcat/kingfisher/master/tutorials/kingfisher/gettingstarteduikit)
    - [SwiftUI Tutorial](https://swiftpackageindex.com/onevcat/kingfisher/master/tutorials/kingfisher/gettingstartedswiftui)
- [Common Tasks - General](https://swiftpackageindex.com/onevcat/kingfisher/master/documentation/kingfisher/commontasks)
    - [Common Tasks - Cache](https://swiftpackageindex.com/onevcat/kingfisher/master/documentation/kingfisher/commontasks_cache)
    - [Common Tasks - Downloader](https://swiftpackageindex.com/onevcat/kingfisher/master/documentation/kingfisher/commontasks_downloader)
    - [Common tasks - Processor](https://swiftpackageindex.com/onevcat/kingfisher/master/documentation/kingfisher/commontasks_processor)

### 마이그레이션

- [Kingfisher 8.0 Migration](https://swiftpackageindex.com/onevcat/kingfisher/master/documentation/kingfisher/migration-to-8)
- [Kingfisher 7.0 Migration](https://github.com/onevcat/Kingfisher/wiki/Kingfisher-7.0-Migration-Guide)

더 이전 버전을 사용하고 있는 경우, 마이그레이션 단계를 알기 위해 아래 가이드를 참조하세요.

## 기타

### Kingfisher의 미래

저는 Kingfisher를 가볍게 유지하고 싶습니다. 이 프레임워크는 이미지 다운로드 및 캐싱을 위한 간단한 솔루션을 제공하는 데 중점을 둡니다. 그렇다고 프레임워크가 개선될 수 없다는 의미는 아닙니다. Kingfisher는 완벽함과는 거리가 멀며, 더 나아지기 위해 필수적이고 유용한 업데이트가 이루어질 것입니다.

### 개발 및 테스트

어떤 기여나 풀 리퀘스트(PR)도 언제나 환영합니다. 하지만 일부 기능을 구현하거나 불확실한 문제를 해결하기 전에 먼저 토론(Discussion)을 여는 것을 권장합니다. 풀 리퀘스트의 모든 테스트가 통과된 상태로 빌드될 수 있다면 매우 감사하겠습니다. :)

### 로고에 대하여

Kingfisher의 로고는 중국의 7개 평면 도형으로 이루어진 조립 퍼즐인 [Tangram (칠교판)](https://en.wikipedia.org/wiki/Tangram)에서 영감을 받았습니다. 저는 이 로고가 제비(swift)가 아니라 물총새(kingfisher)라고 믿지만, 누군가는 비둘기라고 우기네요. 이름을 지어주어야 할 것 같습니다. 여러분, 좋은 제안이 있으신가요?

### 연락처

[Twitter](https://twitter.com/onevcat) 또는 [Sina Weibo](https://weibo.com/onevcat)를 팔로우하고 연락주세요. 문제를 발견하셨다면 [티켓을 열어주세요](https://github.com/onevcat/Kingfisher/issues/new). 풀 리퀘스트 역시 언제나 환영합니다.

## 후원자 및 스폰서

오픈 소스 프로젝트는 여러분의 도움 없이는 오래 지속될 수 없습니다. Kingfisher가 유용하다고 생각되신다면, 스폰서가 되어 이 프로젝트를 지원하는 것을 고려해 주세요. 여러분의 유저 아이콘이나 회사 로고가 홈 페이지 링크와 함께 [제 블로그에](https://onevcat.com/tabs/about/) 표시됩니다.

[GitHub Sponsors](https://github.com/sponsors/onevcat)를 통해 스폰서가 되어보세요. :heart:

특별히 감사한 분들:

[![imgly](https://user-images.githubusercontent.com/1812216/106253726-271ed000-6218-11eb-98e0-c9c681925770.png)](https://img.ly/)

[![emergetools](https://github-production-user-asset-6210df.s3.amazonaws.com/1019875/254794187-d44f6f50-993f-42e3-b79c-960f69c4adc1.png)](https://www.emergetools.com)

### 라이선스

Kingfisher는 MIT 라이선스 하에 배포됩니다. 자세한 내용은 LICENSE를 참조하세요.

Kingfisher

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README